diff options
author | Alex Turbov <i.zaufi@gmail.com> | 2022-08-04 09:45:23 (GMT) |
---|---|---|
committer | Alex Turbov <i.zaufi@gmail.com> | 2022-08-04 15:34:45 (GMT) |
commit | 04843d743e08beeb257f6ce781633b2a9647ab07 (patch) | |
tree | 46607d1f086a823e01f540d40ed27f2ee8891b87 /Help/command | |
parent | 09446266ee701513315b483d8a0169a51b69e783 (diff) | |
download | CMake-04843d743e08beeb257f6ce781633b2a9647ab07.zip CMake-04843d743e08beeb257f6ce781633b2a9647ab07.tar.gz CMake-04843d743e08beeb257f6ce781633b2a9647ab07.tar.bz2 |
Help: Replace a bunch of more ``--option`` to `:option:` role
Diffstat (limited to 'Help/command')
-rw-r--r-- | Help/command/cmake_language.rst | 3 | ||||
-rw-r--r-- | Help/command/ctest_test.rst | 5 | ||||
-rw-r--r-- | Help/command/find_package.rst | 2 | ||||
-rw-r--r-- | Help/command/get_test_property.rst | 3 | ||||
-rw-r--r-- | Help/command/install.rst | 6 | ||||
-rw-r--r-- | Help/command/message.rst | 7 | ||||
-rw-r--r-- | Help/command/try_compile.rst | 19 | ||||
-rw-r--r-- | Help/command/try_run.rst | 4 |
8 files changed, 27 insertions, 22 deletions
diff --git a/Help/command/cmake_language.rst b/Help/command/cmake_language.rst index 377e42d..d0c7c19 100644 --- a/Help/command/cmake_language.rst +++ b/Help/command/cmake_language.rst @@ -510,7 +510,8 @@ into the given ``<output_variable>``. See :command:`message` for the possible logging levels. -The current message logging level can be set either using the ``--log-level`` +The current message logging level can be set either using the +:option:`--log-level <cmake --log-level>` command line option of the :manual:`cmake(1)` program or using the :variable:`CMAKE_MESSAGE_LOG_LEVEL` variable. diff --git a/Help/command/ctest_test.rst b/Help/command/ctest_test.rst index 11ebdbd..f058150 100644 --- a/Help/command/ctest_test.rst +++ b/Help/command/ctest_test.rst @@ -109,8 +109,9 @@ The options are: While running tests in parallel, try not to start tests when they may cause the CPU load to pass above a given threshold. If not specified the :variable:`CTEST_TEST_LOAD` variable will be checked, - and then the ``--test-load`` command-line argument to :manual:`ctest(1)`. - See also the ``TestLoad`` setting in the :ref:`CTest Test Step`. + and then the :option:`--test-load <ctest --test-load>` command-line + argument to :manual:`ctest(1)`. See also the ``TestLoad`` setting + in the :ref:`CTest Test Step`. ``REPEAT <mode>:<n>`` .. versionadded:: 3.17 diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst index ee52c41..e1759bf 100644 --- a/Help/command/find_package.rst +++ b/Help/command/find_package.rst @@ -368,7 +368,7 @@ enabled. See policy :policy:`CMP0074`. 2. Search paths specified in cmake-specific cache variables. These - are intended to be used on the command line with a ``-DVAR=value``. + are intended to be used on the command line with a :option:`-DVAR=VALUE <cmake -D>`. The values are interpreted as :ref:`semicolon-separated lists <CMake Language Lists>`. This can be skipped if ``NO_CMAKE_PATH`` is passed or by setting the :variable:`CMAKE_FIND_USE_CMAKE_PATH` to ``FALSE``: diff --git a/Help/command/get_test_property.rst b/Help/command/get_test_property.rst index e02b9bc..6bcc1ef 100644 --- a/Help/command/get_test_property.rst +++ b/Help/command/get_test_property.rst @@ -16,6 +16,7 @@ relevant parent scope as described for the :command:`define_property` command and if still unable to find the property, ``VAR`` will be set to an empty string. -For a list of standard properties you can type ``cmake --help-property-list``. +For a list of standard properties you can type +:option:`cmake --help-property-list`. See also the more general :command:`get_property` command. diff --git a/Help/command/install.rst b/Help/command/install.rst index 5aa3a4b..e2aeaad 100644 --- a/Help/command/install.rst +++ b/Help/command/install.rst @@ -963,12 +963,12 @@ Generated Installation Script .. note:: Use of this feature is not recommended. Please consider using the - ``--install`` argument of :manual:`cmake(1)` instead. + :option:`cmake --install` instead. The ``install()`` command generates a file, ``cmake_install.cmake``, inside the build directory, which is used internally by the generated install target -and by CPack. You can also invoke this script manually with ``cmake -P``. This -script accepts several variables: +and by CPack. You can also invoke this script manually with +:option:`cmake -P <cmake_P -P>`. This script accepts several variables: ``COMPONENT`` Set this variable to install only a single CPack component as opposed to all diff --git a/Help/command/message.rst b/Help/command/message.rst index ca4f5c1..77d21c8 100644 --- a/Help/command/message.rst +++ b/Help/command/message.rst @@ -83,8 +83,9 @@ are sent to stderr and are not prefixed with hyphens. The :manual:`CMake GUI <cmake-gui(1)>` displays all messages in its log area. The :manual:`curses interface <ccmake(1)>` shows ``STATUS`` to ``TRACE`` messages one at a time on a status line and other messages in an -interactive pop-up box. The ``--log-level`` command-line option to each of -these tools can be used to control which messages will be shown. +interactive pop-up box. The :option:`--log-level <cmake --log-level>` +command-line option to each of these tools can be used to control which +messages will be shown. .. versionadded:: 3.17 To make a log level persist between CMake runs, the @@ -104,7 +105,7 @@ these tools can be used to control which messages will be shown. list variable to a dot-separated string. The message context will always appear before any indenting content but after any automatically added leading hyphens. By default, message context is not shown, it has to be explicitly - enabled by giving the :manual:`cmake <cmake(1)>` ``--log-context`` + enabled by giving the :option:`cmake --log-context` command-line option or by setting the :variable:`CMAKE_MESSAGE_CONTEXT_SHOW` variable to true. See the :variable:`CMAKE_MESSAGE_CONTEXT` documentation for usage examples. diff --git a/Help/command/try_compile.rst b/Help/command/try_compile.rst index 806a98d..e03ab80 100644 --- a/Help/command/try_compile.rst +++ b/Help/command/try_compile.rst @@ -79,8 +79,8 @@ contain something like the following: The options are: ``CMAKE_FLAGS <flags>...`` - Specify flags of the form ``-DVAR:TYPE=VALUE`` to be passed to - the ``cmake`` command-line used to drive the test build. + Specify flags of the form :option:`-DVAR:TYPE=VALUE <cmake -D>` to be passed + to the :manual:`cmake(1)` command-line used to drive the test build. The above example shows how values for variables ``INCLUDE_DIRECTORIES``, ``LINK_DIRECTORIES``, and ``LINK_LIBRARIES`` are used. @@ -137,15 +137,16 @@ The options are: or :prop_tgt:`CUDA_EXTENSIONS` target property of the generated project. In this version all files in ``<bindir>/CMakeFiles/CMakeTmp`` will be -cleaned automatically. For debugging, ``--debug-trycompile`` can be +cleaned automatically. For debugging, +:option:`--debug-trycompile <cmake --debug-trycompile>` can be passed to ``cmake`` to avoid this clean. However, multiple sequential ``try_compile`` operations reuse this single output directory. If you use -``--debug-trycompile``, you can only debug one ``try_compile`` call at a time. -The recommended procedure is to protect all ``try_compile`` calls in your -project by ``if(NOT DEFINED <resultVar>)`` logic, configure with cmake -all the way through once, then delete the cache entry associated with -the try_compile call of interest, and then re-run cmake again with -``--debug-trycompile``. +:option:`--debug-trycompile <cmake --debug-trycompile>`, you can only debug +one ``try_compile`` call at a time. The recommended procedure is to protect +all ``try_compile`` calls in your project by ``if(NOT DEFINED <resultVar>)`` +logic, configure with cmake all the way through once, then delete the cache +entry associated with the try_compile call of interest, and then re-run cmake +again with :option:`--debug-trycompile <cmake --debug-trycompile>`. Other Behavior Settings ^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/Help/command/try_run.rst b/Help/command/try_run.rst index 125b0ac..938869b 100644 --- a/Help/command/try_run.rst +++ b/Help/command/try_run.rst @@ -35,8 +35,8 @@ information on how the test project is constructed to build the source file. The options are: ``CMAKE_FLAGS <flags>...`` - Specify flags of the form ``-DVAR:TYPE=VALUE`` to be passed to - the ``cmake`` command-line used to drive the test build. + Specify flags of the form :option:`-DVAR:TYPE=VALUE <cmake -D>` to be passed + to the :manual:`cmake(1)` command-line used to drive the test build. The example in :command:`try_compile` shows how values for variables ``INCLUDE_DIRECTORIES``, ``LINK_DIRECTORIES``, and ``LINK_LIBRARIES`` are used. |