Browse Source

Help: Add SHELL, LINKER and host/device discussions to property docs

Section headings are also added for each common block to help guide
the reader and improve navigation.

Fixes: #21640
Craig Scott 4 years ago
parent
commit
2eba7d7524

+ 2 - 0
Help/command/DEVICE_LINK_OPTIONS.txt

@@ -1,3 +1,5 @@
+Host And Device Specific Link Options
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. versionadded:: 3.18
   When a device link step is involved, which is controlled by

+ 3 - 0
Help/command/LINK_OPTIONS_LINKER.txt

@@ -1,3 +1,6 @@
+Handling Compiler Driver Differences
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 To pass options to the linker tool, each compiler driver has its own syntax.
 The ``LINKER:`` prefix and ``,`` separator can be used to specify, in a portable
 way, options to pass to the linker tool. ``LINKER:`` is replaced by the

+ 3 - 0
Help/command/OPTIONS_SHELL.txt

@@ -1,3 +1,6 @@
+Option De-duplication
+^^^^^^^^^^^^^^^^^^^^^
+
 The final set of options used for a target is constructed by
 accumulating options from the current target and the usage requirements of
 its dependencies.  The set of options is de-duplicated to avoid repetition.

+ 2 - 0
Help/prop_tgt/COMPILE_OPTIONS.rst

@@ -15,3 +15,5 @@ Contents of ``COMPILE_OPTIONS`` may use "generator expressions" with the
 syntax ``$<...>``.  See the :manual:`cmake-generator-expressions(7)` manual
 for available expressions.  See the :manual:`cmake-buildsystem(7)` manual
 for more on defining buildsystem properties.
+
+.. include:: ../command/OPTIONS_SHELL.txt

+ 6 - 0
Help/prop_tgt/LINK_OPTIONS.rst

@@ -28,3 +28,9 @@ for more on defining buildsystem properties.
 .. note::
 
   This property must be used in preference to :prop_tgt:`LINK_FLAGS` property.
+
+.. include:: ../command/DEVICE_LINK_OPTIONS.txt
+
+.. include:: ../command/OPTIONS_SHELL.txt
+
+.. include:: ../command/LINK_OPTIONS_LINKER.txt

+ 2 - 0
Help/prop_tgt/STATIC_LIBRARY_OPTIONS.rst

@@ -20,3 +20,5 @@ for more on defining buildsystem properties.
 
   This property must be used in preference to :prop_tgt:`STATIC_LIBRARY_FLAGS`
   property.
+
+.. include:: ../command/OPTIONS_SHELL.txt