mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-03-10 02:19:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Help: Improve formatting of Help documentation

Browse Source
This commit is contained in:
Bartosz Kosiorek
2019-04-05 16:03:53 +02:00
parent ffcb4f7ec5
commit 0e4fbb4a1f
40 changed files with 170 additions and 161 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Help/variable/CMAKE_CROSSCOMPILING_EMULATOR.rst
View File

@@ -6,7 +6,7 @@ should point to a command on the host system that can run executable built
for the target system.
The command will be used to run :command:`try_run` generated executables,
which avoids manual population of the TryRunResults.cmake file.
which avoids manual population of the ``TryRunResults.cmake`` file.
It is also used as the default value for the
:prop_tgt:`CROSSCOMPILING_EMULATOR` target property of executables.

2
Help/variable/CMAKE_CUDA_HOST_COMPILER.rst
View File

@@ -2,6 +2,6 @@ CMAKE_CUDA_HOST_COMPILER
------------------------
Executable to use when compiling host code when compiling ``CUDA`` language
files. Maps to the nvcc -ccbin option. Will only be used by CMake on the first
files. Maps to the ``nvcc -ccbin`` option. Will only be used by CMake on the first
configuration to determine a valid host compiler for ``CUDA``. After a valid
host compiler has been found, this value is read-only.

2
Help/variable/CMAKE_SKIP_INSTALL_RULES.rst
View File

@@ -3,6 +3,6 @@ CMAKE_SKIP_INSTALL_RULES
Whether to disable generation of installation rules.
If ``TRUE``, cmake will neither generate installaton rules nor
If ``TRUE``, CMake will neither generate installation rules nor
will it generate ``cmake_install.cmake`` files. This variable is ``FALSE`` by
default.

2
Help/variable/CMAKE_SOURCE_DIR.rst
View File

@@ -7,7 +7,7 @@ This is the full path to the top level of the current CMake source
tree. For an in-source build, this would be the same as
:variable:`CMAKE_BINARY_DIR`.
When run in -P script mode, CMake sets the variables
When run in ``-P`` script mode, CMake sets the variables
:variable:`CMAKE_BINARY_DIR`, :variable:`CMAKE_SOURCE_DIR`,
:variable:`CMAKE_CURRENT_BINARY_DIR` and
:variable:`CMAKE_CURRENT_SOURCE_DIR` to the current working directory.

10
Help/variable/CMAKE_STAGING_PREFIX.rst
View File

@@ -5,10 +5,10 @@ This variable may be set to a path to install to when cross-compiling. This can
be useful if the path in :variable:`CMAKE_SYSROOT` is read-only, or otherwise
should remain pristine.
The ``CMAKE_STAGING_PREFIX`` location is also used as a search prefix by the
``find_*`` commands. This can be controlled by setting the
The :variable:`CMAKE_STAGING_PREFIX` location is also used as a search prefix
by the ``find_*`` commands. This can be controlled by setting the
:variable:`CMAKE_FIND_NO_INSTALL_PREFIX` variable.
If any RPATH/RUNPATH entries passed to the linker contain the
``CMAKE_STAGING_PREFIX``, the matching path fragments are replaced with the
:variable:`CMAKE_INSTALL_PREFIX`.
If any ``RPATH``/``RUNPATH`` entries passed to the linker contain the
:variable:`CMAKE_STAGING_PREFIX`, the matching path fragments are replaced
with the :variable:`CMAKE_INSTALL_PREFIX`.

8
Help/variable/CMAKE_SUPPRESS_REGENERATION.rst
View File

@@ -1,10 +1,10 @@
CMAKE_SUPPRESS_REGENERATION
---------------------------
If CMAKE_SUPPRESS_REGENERATION is ``OFF``, which is default, then CMake adds a
special target on which all other targets depend that checks the build system
and optionally re-runs CMake to regenerate the build system when the target
specification source changes.
If ``CMAKE_SUPPRESS_REGENERATION`` is ``OFF``, which is default, then CMake
adds a special target on which all other targets depend that checks the build
system and optionally re-runs CMake to regenerate the build system when
the target specification source changes.
If this variable evaluates to ``ON`` at the end of the top-level
``CMakeLists.txt`` file, CMake will not add the regeneration target to the

4
Help/variable/CMAKE_SYSROOT.rst
View File

@@ -4,8 +4,8 @@ CMAKE_SYSROOT
Path to pass to the compiler in the ``--sysroot`` flag.
The ``CMAKE_SYSROOT`` content is passed to the compiler in the ``--sysroot``
flag, if supported. The path is also stripped from the RPATH/RUNPATH if
necessary on installation. The ``CMAKE_SYSROOT`` is also used to prefix
flag, if supported. The path is also stripped from the ``RPATH``/``RUNPATH``
if necessary on installation. The ``CMAKE_SYSROOT`` is also used to prefix
paths searched by the ``find_*`` commands.
This variable may only be set in a toolchain file specified by

2
Help/variable/CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst
View File

@@ -5,7 +5,7 @@ Ask CPack to error out as soon as a file with absolute ``INSTALL DESTINATION``
is encountered.
The fatal error is emitted before the installation of the offending
file takes place. Some CPack generators, like NSIS, enforce this
file takes place. Some CPack generators, like :cpack_gen:`nsis`, enforce this
internally. This variable triggers the definition
of :variable:`CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION` when CPack
runs.

2
Help/variable/PackageName_ROOT.rst
View File

@@ -3,7 +3,7 @@
Calls to :command:`find_package(<PackageName>)` will search in prefixes
specified by the ``<PackageName>_ROOT`` CMake variable, where
``<PackageName>`` is the name given to the ``find_package`` call
``<PackageName>`` is the name given to the :command:`find_package` call
and ``_ROOT`` is literal. For example, ``find_package(Foo)`` will search
prefixes specified in the ``Foo_ROOT`` CMake variable (if set).
See policy :policy:`CMP0074`.