summaryrefslogtreecommitdiffstats
path: root/Help/guide/ide-integration
diff options
context:
space:
mode:
authorAlex Turbov <i.zaufi@gmail.com>2022-08-04 09:45:23 (GMT)
committerAlex Turbov <i.zaufi@gmail.com>2022-08-04 15:34:45 (GMT)
commit04843d743e08beeb257f6ce781633b2a9647ab07 (patch)
tree46607d1f086a823e01f540d40ed27f2ee8891b87 /Help/guide/ide-integration
parent09446266ee701513315b483d8a0169a51b69e783 (diff)
downloadCMake-04843d743e08beeb257f6ce781633b2a9647ab07.zip
CMake-04843d743e08beeb257f6ce781633b2a9647ab07.tar.gz
CMake-04843d743e08beeb257f6ce781633b2a9647ab07.tar.bz2
Help: Replace a bunch of more ``--option`` to `:option:` role
Diffstat (limited to 'Help/guide/ide-integration')
-rw-r--r--Help/guide/ide-integration/index.rst10
1 files changed, 6 insertions, 4 deletions
diff --git a/Help/guide/ide-integration/index.rst b/Help/guide/ide-integration/index.rst
index 7b786dd..e198789 100644
--- a/Help/guide/ide-integration/index.rst
+++ b/Help/guide/ide-integration/index.rst
@@ -47,8 +47,9 @@ does, and present the user with the presets listed in the file. Users should be
able to see (and possibly edit) the CMake cache variables, environment
variables, and command line options that are defined for a given preset. The
IDE should then construct the list of appropriate :manual:`cmake(1)` command
-line arguments based on these settings, rather than using the ``--preset=``
-option directly. The ``--preset=`` option is intended only as a convenient
+line arguments based on these settings, rather than using the
+:option:`--preset= <cmake --preset>` option directly. The
+:option:`--preset= <cmake --preset>` option is intended only as a convenient
frontend for command line users, and should not be used by the IDE.
For example, if a preset named ``ninja`` specifies ``Ninja`` as the generator
@@ -109,8 +110,9 @@ Building
If a Makefile or Ninja generator is used to generate the build tree, it is not
recommended to invoke ``make`` or ``ninja`` directly. Instead, it is
-recommended that the IDE invoke :manual:`cmake(1)` with the ``--build``
-argument, which will in turn invoke the appropriate build tool.
+recommended that the IDE invoke :manual:`cmake(1)` with the
+:option:`--build <cmake --build>` argument, which will in turn invoke the
+appropriate build tool.
If an IDE project generator is used, such as :generator:`Xcode` or one of the
Visual Studio generators, and the IDE understands the project format used, the