From 63940e1cabe24069b81b5c2b56502932b753a123 Mon Sep 17 00:00:00 2001 From: Alex Turbov Date: Thu, 4 Aug 2022 10:51:54 +0400 Subject: Help: Replace mentions of ``-C`` option with :option:`-C` role --- Help/cpack_gen/external.rst | 4 ++-- Help/guide/ide-integration/index.rst | 7 +++---- Help/guide/tutorial/Packaging an Installer.rst | 4 ++-- Help/guide/user-interaction/index.rst | 2 +- 4 files changed, 8 insertions(+), 9 deletions(-) diff --git a/Help/cpack_gen/external.rst b/Help/cpack_gen/external.rst index 4c083f0..b511319 100644 --- a/Help/cpack_gen/external.rst +++ b/Help/cpack_gen/external.rst @@ -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 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 ` 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 ` 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 ` option. For multi-config builds, +use :option:`-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 ` option. This can be useful to simplify commands and scripts which repeatedly require the same cache entries. -- cgit v0.12