diff options
author | Alex Turbov <i.zaufi@gmail.com> | 2022-10-20 02:56:17 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2022-10-20 15:21:40 (GMT) |
commit | 3043c17039b8aa14c1a3ffdaef70ab4010c1be20 (patch) | |
tree | 4b5fe988dca122db6de14ad49e159e8cae9b3061 /Help/guide | |
parent | 7d710abc87a83d96bb3b0f504338c2110d9afa19 (diff) | |
download | CMake-3043c17039b8aa14c1a3ffdaef70ab4010c1be20.zip CMake-3043c17039b8aa14c1a3ffdaef70ab4010c1be20.tar.gz CMake-3043c17039b8aa14c1a3ffdaef70ab4010c1be20.tar.bz2 |
Help: Add more CLI `:option:` references to various pages
Diffstat (limited to 'Help/guide')
-rw-r--r-- | Help/guide/tutorial/Adding Usage Requirements for a Library.rst | 4 | ||||
-rw-r--r-- | Help/guide/tutorial/Installing and Testing.rst | 23 |
2 files changed, 14 insertions, 13 deletions
diff --git a/Help/guide/tutorial/Adding Usage Requirements for a Library.rst b/Help/guide/tutorial/Adding Usage Requirements for a Library.rst index f9dc7cc..4aef050 100644 --- a/Help/guide/tutorial/Adding Usage Requirements for a Library.rst +++ b/Help/guide/tutorial/Adding Usage Requirements for a Library.rst @@ -63,8 +63,8 @@ Build and Run Make a new directory called ``Step3_build``, run the :manual:`cmake <cmake(1)>` executable or the :manual:`cmake-gui <cmake-gui(1)>` to configure the project and then build it with your chosen build tool or by -using ``cmake --build .`` from the build directory. Here's a refresher of -what that looks like from the command line: +using :option:`cmake --build . <cmake --build>` from the build directory. +Here's a refresher of what that looks like from the command line: .. code-block:: console diff --git a/Help/guide/tutorial/Installing and Testing.rst b/Help/guide/tutorial/Installing and Testing.rst index 3969192..fa13040 100644 --- a/Help/guide/tutorial/Installing and Testing.rst +++ b/Help/guide/tutorial/Installing and Testing.rst @@ -52,17 +52,18 @@ Make a new directory called ``Step5_build``. Run the :manual:`cmake-gui <cmake-gui(1)>` to configure the project and then build it with your chosen build tool. -Then, run the install step by using the ``install`` option of the -:manual:`cmake <cmake(1)>` command (introduced in 3.15, older versions of -CMake must use ``make install``) from the command line. This step will -install the appropriate header files, libraries, and executables. For example: +Then, run the install step by using the :option:`--install <cmake --install>` +option of the :manual:`cmake <cmake(1)>` command (introduced in 3.15, older +versions of CMake must use ``make install``) from the command line. This step +will install the appropriate header files, libraries, and executables. +For example: .. code-block:: console cmake --install . -For multi-configuration tools, don't forget to use the ``--config`` argument to -specify the configuration. +For multi-configuration tools, don't forget to use the +:option:`--config <cmake--build --config>` argument to specify the configuration. .. code-block:: console @@ -76,9 +77,9 @@ install target from the command line like the following: cmake --build . --target install --config Debug The CMake variable :variable:`CMAKE_INSTALL_PREFIX` is used to determine the -root of where the files will be installed. If using the ``cmake --install`` -command, the installation prefix can be overridden via the ``--prefix`` -argument. For example: +root of where the files will be installed. If using the :option:`cmake --install` +command, the installation prefix can be overridden via the +:option:`--prefix <cmake--install --prefix>` argument. For example: .. code-block:: console @@ -194,9 +195,9 @@ Build and Run ------------- Navigate to the build directory and rebuild the application. Then, run the -:manual:`ctest <ctest(1)>` executable: ``ctest -N`` and ``ctest -VV``. For +``ctest`` executable: :option:`ctest -N` and :option:`ctest -VV`. For multi-config generators (e.g. Visual Studio), the configuration type must be -specified with the ``-C <mode>`` flag. For example, to run tests in Debug +specified with the :option:`-C \<mode\> <ctest -C>` flag. For example, to run tests in Debug mode use ``ctest -C Debug -VV`` from the build directory (not the Debug subdirectory!). Release mode would be executed from the same location but with a ``-C Release``. Alternatively, build the ``RUN_TESTS`` |