mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-02-25 10:18:34 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Add more CLI :option: references to various pages

Browse Source
This commit is contained in:
Alex Turbov
2022-10-20 06:56:17 +04:00
committed by Brad King
parent 7d710abc87
commit 3043c17039
12 changed files with 35 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Help/guide/tutorial/Adding Usage Requirements for a Library.rst
View File

@@ -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

23
Help/guide/tutorial/Installing and Testing.rst
View File

@@ -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``