summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2022-10-21 14:19:16 (GMT)
committerKitware Robot <kwrobot@kitware.com>2022-10-21 14:19:53 (GMT)
commit63d28469cdfa24848f8374a9f77da92360b90898 (patch)
tree8cf888d996c2b4f81502a99c5ec3c212c2e6289c /Help/command
parentfbea7d4181e284a057cf6e4ab4ed9bbd01b021bd (diff)
parent3043c17039b8aa14c1a3ffdaef70ab4010c1be20 (diff)
downloadCMake-63d28469cdfa24848f8374a9f77da92360b90898.zip
CMake-63d28469cdfa24848f8374a9f77da92360b90898.tar.gz
CMake-63d28469cdfa24848f8374a9f77da92360b90898.tar.bz2
Merge topic 'doc-cli-xrefs' into release-3.25
3043c17039 Help: Add more CLI `:option:` references to various pages Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7811
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/build_command.rst8
-rw-r--r--Help/command/ctest_build.rst6
-rw-r--r--Help/command/set.rst2
3 files changed, 8 insertions, 8 deletions
diff --git a/Help/command/build_command.rst b/Help/command/build_command.rst
index a03979d..3d86a2e 100644
--- a/Help/command/build_command.rst
+++ b/Help/command/build_command.rst
@@ -24,12 +24,12 @@ options, if any. The trailing ``-- -i`` option is added for
:ref:`Makefile Generators` if policy :policy:`CMP0061` is not set to
``NEW``.
-When invoked, this ``cmake --build`` command line will launch the
+When invoked, this :option:`cmake --build` command line will launch the
underlying build system tool.
.. versionadded:: 3.21
- The ``PARALLEL_LEVEL`` argument can be used to set the ``--parallel``
- flag.
+ The ``PARALLEL_LEVEL`` argument can be used to set the
+ :option:`--parallel <cmake--build --parallel>` flag.
.. code-block:: cmake
@@ -39,7 +39,7 @@ This second signature is deprecated, but still available for backwards
compatibility. Use the first signature instead.
It sets the given ``<cachevariable>`` to a command-line string as
-above but without the ``--target`` option.
+above but without the :option:`--target <cmake--build --target>` option.
The ``<makecommand>`` is ignored but should be the full path to
devenv, nmake, make or one of the end user build tools
for legacy invocations.
diff --git a/Help/command/ctest_build.rst b/Help/command/ctest_build.rst
index e05df1a..8c81f2d 100644
--- a/Help/command/ctest_build.rst
+++ b/Help/command/ctest_build.rst
@@ -40,8 +40,8 @@ The options are:
``CONFIGURATION <config>``
Specify the build configuration (e.g. ``Debug``). If not
specified the ``CTEST_BUILD_CONFIGURATION`` variable will be checked.
- Otherwise the ``-C <cfg>`` option given to the :manual:`ctest(1)`
- command will be used, if any.
+ Otherwise the :option:`-C \<cfg\> <ctest -C>` option given to the
+ :manual:`ctest(1)` command will be used, if any.
``PARALLEL_LEVEL <parallel>``
.. versionadded:: 3.21
@@ -54,7 +54,7 @@ The options are:
Pass additional arguments to the underlying build command.
If not specified the ``CTEST_BUILD_FLAGS`` variable will be checked.
This can, e.g., be used to trigger a parallel build using the
- ``-j`` option of make. See the :module:`ProcessorCount` module
+ ``-j`` option of ``make``. See the :module:`ProcessorCount` module
for an example.
``PROJECT_NAME <project-name>``
diff --git a/Help/command/set.rst b/Help/command/set.rst
index 5e05d9b..90b57d2 100644
--- a/Help/command/set.rst
+++ b/Help/command/set.rst
@@ -83,7 +83,7 @@ option is given then the cache entry will be set to the given value.
It is possible for the cache entry to exist prior to the call but
have no type set if it was created on the :manual:`cmake(1)` command
-line by a user through the ``-D<var>=<value>`` option without
+line by a user through the :option:`-D\<var\>=\<value\> <cmake -D>` option without
specifying a type. In this case the ``set`` command will add the
type. Furthermore, if the ``<type>`` is ``PATH`` or ``FILEPATH``
and the ``<value>`` provided on the command line is a relative path,