diff options
author | Brad King <brad.king@kitware.com> | 2022-10-05 18:33:10 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2022-10-05 19:27:40 (GMT) |
commit | b768a5e23ba58b1eaf747c54451a5a255663650b (patch) | |
tree | 93ce8d691dcc28f9dc869400ef60db4ab6ef22d6 /Help/variable | |
parent | 6ace9562e730328b87ad5b56390e70cb7704050a (diff) | |
download | CMake-b768a5e23ba58b1eaf747c54451a5a255663650b.zip CMake-b768a5e23ba58b1eaf747c54451a5a255663650b.tar.gz CMake-b768a5e23ba58b1eaf747c54451a5a255663650b.tar.bz2 |
Help: Disambiguate cmake(1) program modes in Sphinx option references
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.
Diffstat (limited to 'Help/variable')
-rw-r--r-- | Help/variable/CMAKE_BINARY_DIR.rst | 2 | ||||
-rw-r--r-- | Help/variable/CMAKE_CURRENT_BINARY_DIR.rst | 2 | ||||
-rw-r--r-- | Help/variable/CMAKE_CURRENT_SOURCE_DIR.rst | 2 | ||||
-rw-r--r-- | Help/variable/CMAKE_INSTALL_PREFIX.rst | 4 | ||||
-rw-r--r-- | Help/variable/CMAKE_SCRIPT_MODE_FILE.rst | 4 | ||||
-rw-r--r-- | Help/variable/CMAKE_SOURCE_DIR.rst | 2 |
6 files changed, 8 insertions, 8 deletions
diff --git a/Help/variable/CMAKE_BINARY_DIR.rst b/Help/variable/CMAKE_BINARY_DIR.rst index f9c7689..e601eb8 100644 --- a/Help/variable/CMAKE_BINARY_DIR.rst +++ b/Help/variable/CMAKE_BINARY_DIR.rst @@ -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. diff --git a/Help/variable/CMAKE_CURRENT_BINARY_DIR.rst b/Help/variable/CMAKE_CURRENT_BINARY_DIR.rst index 6f82dcc..15f81d2 100644 --- a/Help/variable/CMAKE_CURRENT_BINARY_DIR.rst +++ b/Help/variable/CMAKE_CURRENT_BINARY_DIR.rst @@ -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. diff --git a/Help/variable/CMAKE_CURRENT_SOURCE_DIR.rst b/Help/variable/CMAKE_CURRENT_SOURCE_DIR.rst index 0678f99..5b86026 100644 --- a/Help/variable/CMAKE_CURRENT_SOURCE_DIR.rst +++ b/Help/variable/CMAKE_CURRENT_SOURCE_DIR.rst @@ -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. diff --git a/Help/variable/CMAKE_INSTALL_PREFIX.rst b/Help/variable/CMAKE_INSTALL_PREFIX.rst index 1636739..c76727e 100644 --- a/Help/variable/CMAKE_INSTALL_PREFIX.rst +++ b/Help/variable/CMAKE_INSTALL_PREFIX.rst @@ -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 diff --git a/Help/variable/CMAKE_SCRIPT_MODE_FILE.rst b/Help/variable/CMAKE_SCRIPT_MODE_FILE.rst index 104f4ac..313fb4e 100644 --- a/Help/variable/CMAKE_SCRIPT_MODE_FILE.rst +++ b/Help/variable/CMAKE_SCRIPT_MODE_FILE.rst @@ -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. diff --git a/Help/variable/CMAKE_SOURCE_DIR.rst b/Help/variable/CMAKE_SOURCE_DIR.rst index 32e6e90..7210f75 100644 --- a/Help/variable/CMAKE_SOURCE_DIR.rst +++ b/Help/variable/CMAKE_SOURCE_DIR.rst @@ -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. |