Commit 2d7d33ec authored by Gregor Jasny's avatar Gregor Jasny

Help: Hyperlink properties

parent edf1c8e3
......@@ -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
then that is effectively pushing the included listfile onto the stack.
being processed, in order. So if one listfile does an
:command:`include` command then that is effectively pushing the
included listfile onto the stack.
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
directories called lib in the search path when building 64-bit
binaries.
:command:`find_library` command should automatically search the lib64
variant of directories called lib in the search path when building
64-bit binaries.
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
should find shared libraries with OpenBSD-style versioned extension:
".so.<major>.<minor>". The property is set to true on OpenBSD and
false on other platforms.
This property is a boolean specifying whether the
:command:`find_library` command should find shared libraries with
OpenBSD-style versioned extension: ".so.<major>.<minor>". The
property is set to true on OpenBSD and false on other platforms.
......@@ -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.
......@@ -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
target property.
organized into this FOLDER. See also the documentation for the
:prop_tgt:`FOLDER` target property.
......@@ -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
value initializes the value of this property. Non-Makefile generators
currently ignore this property.
of detailed reports. If a ``CMAKE_RULE_MESSAGES`` cache entry exists
its value initializes the value of this property. Non-Makefile
generators currently ignore this property.
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.
See also the documentation for the FOLDER target property.
use the values of the :prop_tgt:`FOLDER` target property to name those
folders. See also the documentation for the FOLDER target property.
......@@ -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
preprocessor definitions.
source file builds. Use :prop_sf:`COMPILE_DEFINITIONS` to pass
additional preprocessor definitions.
......@@ -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
test does not pass.
Same as :prop_test:`ATTACHED_FILES`, but these files will only be
included if the test does not pass.
......@@ -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
build sources within the target. Use COMPILE_DEFINITIONS to pass
additional preprocessor definitions.
The ``COMPILE_FLAGS`` property sets additional compiler flags used to
build sources within the target. Use :prop_tgt:`COMPILE_DEFINITIONS`
to pass additional preprocessor definitions.
This property is deprecated. Use the COMPILE_OPTIONS property or the
target_compile_options command instead.
This property is deprecated. Use the :prop_tgt:`COMPILE_OPTIONS`
property or the command:`target_compile_options` command instead.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment