diff options
| author | Alex Turbov <i.zaufi@gmail.com> | 2022-08-04 06:51:54 (GMT) |
|---|---|---|
| committer | Alex Turbov <i.zaufi@gmail.com> | 2022-08-04 15:34:44 (GMT) |
| commit | 63940e1cabe24069b81b5c2b56502932b753a123 (patch) | |
| tree | 84a4141decbe4a9ae2cc2ad102362ea54486bd21 /Help/guide | |
| parent | 183a49cbfe0359072e379a30295355ecfb9c70a5 (diff) | |
| download | CMake-63940e1cabe24069b81b5c2b56502932b753a123.zip CMake-63940e1cabe24069b81b5c2b56502932b753a123.tar.gz CMake-63940e1cabe24069b81b5c2b56502932b753a123.tar.bz2 | |
Help: Replace mentions of ``-C`` option with :option:`-C` role
Diffstat (limited to 'Help/guide')
| -rw-r--r-- | Help/guide/ide-integration/index.rst | 7 | ||||
| -rw-r--r-- | Help/guide/tutorial/Packaging an Installer.rst | 4 | ||||
| -rw-r--r-- | Help/guide/user-interaction/index.rst | 2 |
3 files changed, 6 insertions, 7 deletions
diff --git a/Help/guide/ide-integration/index.rst b/Help/guide/ide-integration/index.rst index 8473481..7b786dd 100644 --- a/Help/guide/ide-integration/index.rst +++ b/Help/guide/ide-integration/index.rst @@ -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 diff --git a/Help/guide/tutorial/Packaging an Installer.rst b/Help/guide/tutorial/Packaging an Installer.rst index 5f0b27a..328bf1b 100644 --- a/Help/guide/tutorial/Packaging an Installer.rst +++ b/Help/guide/tutorial/Packaging an Installer.rst @@ -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 diff --git a/Help/guide/user-interaction/index.rst b/Help/guide/user-interaction/index.rst index ba8196b..39de0e5 100644 --- a/Help/guide/user-interaction/index.rst +++ b/Help/guide/user-interaction/index.rst @@ -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. |