Merge topic 'hyperlink-documentation'

2d7d33ec Help: Hyperlink properties

Help/prop_dir/LISTFILE_STACK.rst

@@ -5,5 +5,6 @@ The current stack of listfiles being processed.
 
 This property is mainly useful when trying to debug errors in your
 CMake scripts.  It returns a list of what list files are currently
-being processed, in order.  So if one listfile does an INCLUDE command
+being processed, in order.  So if one listfile does an
-then that is effectively pushing the included listfile onto the stack.
+:command:`include` command then that is effectively pushing the
+included listfile onto the stack.

Help/prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS.rst

@@ -1,9 +1,10 @@
 FIND_LIBRARY_USE_LIB64_PATHS
 ----------------------------
 
-Whether FIND_LIBRARY should automatically search lib64 directories.
+Whether :command:`find_library` should automatically search lib64
+directories.
 
 FIND_LIBRARY_USE_LIB64_PATHS is a boolean specifying whether the
-FIND_LIBRARY command should automatically search the lib64 variant of
+:command:`find_library` command should automatically search the lib64
-directories called lib in the search path when building 64-bit
+variant of directories called lib in the search path when building
-binaries.
+64-bit binaries.

Help/prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING.rst

@@ -1,9 +1,10 @@
 FIND_LIBRARY_USE_OPENBSD_VERSIONING
 -----------------------------------
 
-Whether FIND_LIBRARY should find OpenBSD-style shared libraries.
+Whether :command:`find_library` should find OpenBSD-style shared
+libraries.
 
-This property is a boolean specifying whether the FIND_LIBRARY command
+This property is a boolean specifying whether the
-should find shared libraries with OpenBSD-style versioned extension:
+:command:`find_library` command should find shared libraries with
-".so.<major>.<minor>".  The property is set to true on OpenBSD and
+OpenBSD-style versioned extension: ".so.<major>.<minor>".  The
-false on other platforms.
+property is set to true on OpenBSD and false on other platforms.

Help/prop_gbl/IN_TRY_COMPILE.rst

@@ -3,4 +3,5 @@ IN_TRY_COMPILE
 
 Read-only property that is true during a try-compile configuration.
 
-True when building a project inside a TRY_COMPILE or TRY_RUN command.
+True when building a project inside a :command:`try_compile` or
+:command:`try_run` command.

Help/prop_gbl/PREDEFINED_TARGETS_FOLDER.rst

@@ -5,5 +5,5 @@ Name of FOLDER for targets that are added automatically by CMake.
 
 If not set, CMake uses "CMakePredefinedTargets" as a default value for
 this property.  Targets such as INSTALL, PACKAGE and RUN_TESTS will be
-organized into this FOLDER.  See also the documentation for the FOLDER
+organized into this FOLDER.  See also the documentation for the
-target property.
+:prop_tgt:`FOLDER` target property.

Help/prop_gbl/RULE_MESSAGES.rst

@@ -8,6 +8,6 @@ progress message describing what each build rule does.  If the
 property is not set the default is ON.  Set the property to OFF to
 disable granular messages and report only as each target completes.
 This is intended to allow scripted builds to avoid the build time cost
-of detailed reports.  If a CMAKE_RULE_MESSAGES cache entry exists its
+of detailed reports.  If a ``CMAKE_RULE_MESSAGES`` cache entry exists
-value initializes the value of this property.  Non-Makefile generators
+its value initializes the value of this property.  Non-Makefile
-currently ignore this property.
+generators currently ignore this property.

Help/prop_gbl/USE_FOLDERS.rst

@@ -1,9 +1,10 @@
 USE_FOLDERS
 -----------
 
-Use the FOLDER target property to organize targets into folders.
+Use the :prop_tgt:`FOLDER` target property to organize targets into
+folders.
 
 If not set, CMake treats this property as OFF by default.  CMake
 generators that are capable of organizing into a hierarchy of folders
-use the values of the FOLDER target property to name those folders.
+use the values of the :prop_tgt:`FOLDER` target property to name those
-See also the documentation for the FOLDER target property.
+folders. See also the documentation for the FOLDER target property.

Help/prop_sf/COMPILE_FLAGS.rst

@@ -4,5 +4,5 @@ COMPILE_FLAGS
 Additional flags to be added when compiling this source file.
 
 These flags will be added to the list of compile flags when this
-source file builds.  Use COMPILE_DEFINITIONS to pass additional
+source file builds.  Use :prop_sf:`COMPILE_DEFINITIONS` to pass
-preprocessor definitions.
+additional preprocessor definitions.

Help/prop_test/ATTACHED_FILES_ON_FAIL.rst

@@ -3,5 +3,5 @@ ATTACHED_FILES_ON_FAIL
 
 Attach a list of files to a dashboard submission if the test fails.
 
-Same as ATTACHED_FILES, but these files will only be included if the
+Same as :prop_test:`ATTACHED_FILES`, but these files will only be
-test does not pass.
+included if the test does not pass.

Help/prop_tgt/COMPILE_FLAGS.rst

@@ -3,9 +3,9 @@ COMPILE_FLAGS
 
 Additional flags to use when compiling this target's sources.
 
-The COMPILE_FLAGS property sets additional compiler flags used to
+The ``COMPILE_FLAGS`` property sets additional compiler flags used to
-build sources within the target.  Use COMPILE_DEFINITIONS to pass
+build sources within the target.  Use :prop_tgt:`COMPILE_DEFINITIONS`
-additional preprocessor definitions.
+to pass additional preprocessor definitions.
 
-This property is deprecated.  Use the COMPILE_OPTIONS property or the
+This property is deprecated.  Use the :prop_tgt:`COMPILE_OPTIONS`
-target_compile_options command instead.
+property or the command:`target_compile_options` command instead.