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

Help: Disambiguate cmake(1) program modes in Sphinx option references

Browse Source 
Define the entry point to each mode as an option for the `cmake`
program, but reference the options for that mode as part of stand-in
`cmake-<mode>` programs.
This commit is contained in:
Brad King
2022-10-05 14:33:10 -04:00
parent 6ace9562e7
commit b768a5e23b
13 changed files with 64 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Help/variable/CMAKE_BINARY_DIR.rst
+1 -1
View File
@@ -7,7 +7,7 @@ This is the full path to the top level of the current CMake build
tree. For an in-source build, this would be the same as
:variable:`CMAKE_SOURCE_DIR`.
When run in :option:`-P <cmake_P -P>` script mode, CMake sets the variables
When run in :option:`cmake -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.
Help/variable/CMAKE_CURRENT_BINARY_DIR.rst
+1 -1
View File
@@ -9,7 +9,7 @@ create a binary directory in the build tree, and as it is being
processed this variable will be set. For in-source builds this is the
current source directory being processed.
When run in :option:`-P <cmake_P -P>` script mode, CMake sets the variables
When run in :option:`cmake -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.
Help/variable/CMAKE_CURRENT_SOURCE_DIR.rst
+1 -1
View File
@@ -6,7 +6,7 @@ The path to the source directory currently being processed.
This is the full path to the source directory that is currently being
processed by cmake.
When run in :option:`-P <cmake_P -P>` script mode, CMake sets the variables
When run in :option:`cmake -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.
Help/variable/CMAKE_INSTALL_PREFIX.rst
+2 -2
View File
@@ -27,8 +27,8 @@ first :command:`project` invocation.
The ``CMAKE_INSTALL_PREFIX`` may be defined when configuring a build tree
to set its installation prefix. Or, when using the :manual:`cmake(1)`
command-line tool's :option:`--install <cmake --install>` mode, one may
specify a different prefix using the :option:`--prefix <cmake --prefix>`
command-line tool's :option:`--install <cmake --install>` mode, one may specify
a different prefix using the :option:`--prefix <cmake--install --prefix>`
option:
.. code-block:: shell
Help/variable/CMAKE_SCRIPT_MODE_FILE.rst
+2 -2
View File
@@ -1,9 +1,9 @@
CMAKE_SCRIPT_MODE_FILE
----------------------
Full path to the :option:`cmake -P <cmake_P -P>` script file currently being
Full path to the :option:`cmake -P` script file currently being
processed.
When run in :option:`cmake -P <cmake_P -P>` script mode, CMake sets this variable to
When run in :option:`cmake -P` script mode, CMake sets this variable to
the full path of the script file. When run to configure a ``CMakeLists.txt``
file, this variable is not set.
Help/variable/CMAKE_SOURCE_DIR.rst
+1 -1
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 :option:`-P <cmake_P -P>` script mode, CMake sets the variables
When run in :option:`cmake -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.