echo/CMake
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Help: Replace mentions of `-C option with :option:-C` role

Browse Source
This commit is contained in:
Alex Turbov 2022-08-04 10:51:54 +04:00
parent 183a49cbfe
commit 63940e1cab
4 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Help/cpack_gen/external.rst
View File

@ -207,8 +207,8 @@ following fields in the root:
set.
``buildConfig``
The build configuration given to CPack with the ``-C`` option. Only present
if this option is set.
The build configuration given to CPack with the :option:`cpack -C` option.
Only present if this option is set.
``defaultDirectoryPermissions``
The default directory permissions given in

7
Help/guide/ide-integration/index.rst
View File

@ -66,10 +66,9 @@ run:
cmake -S /path/to/source -B /path/to/source/build -G Ninja
In cases where a preset contains lots of cache variables, and passing all of
them as ``-D`` flags would cause the command line length limit of the platform
to be exceeded, the IDE should instead construct a temporary cache script and
pass it with the ``-C`` flag. See :ref:`CMake Options` for details on how the
``-C`` flag is used.
them as :option:`-D <cmake -D>` flags would cause the command line length limit
of the platform to be exceeded, the IDE should instead construct a temporary
cache script and pass it with the :option:`-C <cmake -C>` flag.
While reading, parsing, and evaluating the contents of ``CMakePresets.json`` is
straightforward, it is not trivial. In addition to the documentation, IDE

4
Help/guide/tutorial/Packaging an Installer.rst
View File

@ -38,8 +38,8 @@ binary directory run:
cpack
To specify the generator, use the ``-G`` option. For multi-config builds, use
``-C`` to specify the configuration. For example:
To specify the generator, use the :option:`-G <cpack -G>` option. For multi-config builds,
use :option:`-C <cpack -C>` to specify the configuration. For example:
.. code-block:: console

2
Help/guide/user-interaction/index.rst
View File

@ -351,7 +351,7 @@ on the command line can be modified using the
The :manual:`cmake(1)` tool allows specifying a
file to use to populate the initial cache using
the ``-C`` option. This can be useful to simplify
the :option:`-C <cmake -C>` option. This can be useful to simplify
commands and scripts which repeatedly require the
same cache entries.