summaryrefslogtreecommitdiff
path: root/Help/guide
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2022-10-05 14:33:10 -0400
committerBrad King <brad.king@kitware.com>2022-10-05 15:27:40 -0400
commitb768a5e23ba58b1eaf747c54451a5a255663650b (patch)
tree93ce8d691dcc28f9dc869400ef60db4ab6ef22d6 /Help/guide
parent6ace9562e730328b87ad5b56390e70cb7704050a (diff)
downloadcmake-b768a5e23ba58b1eaf747c54451a5a255663650b.tar.gz
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/guide')
-rw-r--r--Help/guide/user-interaction/index.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/Help/guide/user-interaction/index.rst b/Help/guide/user-interaction/index.rst
index 9cc58163b7..335599223a 100644
--- a/Help/guide/user-interaction/index.rst
+++ b/Help/guide/user-interaction/index.rst
@@ -511,7 +511,7 @@ command associated with the
the build tool configured by the user.
The :option:`--build <cmake --build>` mode also accepts
-the parameter :option:`--target <cmake --target>` to
+the parameter :option:`--target <cmake--build --target>` to
specify a particular target to build, for example a
particular library, executable or custom target, or a
particular special target like ``install``:
@@ -521,7 +521,7 @@ particular special target like ``install``:
$ cmake --build . --target myexe
The :option:`--build <cmake --build>` mode also accepts a
-:option:`--config <cmake --config>` parameter
+:option:`--config <cmake--build --config>` parameter
in the case of multi-config generators to specify which
particular configuration to build:
@@ -529,13 +529,13 @@ particular configuration to build:
$ cmake --build . --target myexe --config Release
-The :option:`--config <cmake --config>` option has no
+The :option:`--config <cmake--build --config>` option has no
effect if the generator generates a buildsystem specific
to a configuration which is chosen when invoking cmake
with the :variable:`CMAKE_BUILD_TYPE` variable.
Some buildsystems omit details of command lines invoked
-during the build. The :option:`-verbose <cmake --verbose>`
+during the build. The :option:`--verbose <cmake--build --verbose>`
flag can be used to cause those command lines to be shown:
.. code-block:: console