Bladeren bron

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

Alex Turbov 3 jaren geleden
bovenliggende
commit
d25b232dee

+ 1 - 1
Help/cpack_gen/rpm.rst

@@ -972,7 +972,7 @@ For CMake projects SRPM package would be produced by executing::
  Produced SRPM package is expected to be built with :manual:`cmake(1)` executable
  and packaged with :manual:`cpack(1)` executable so CMakeLists.txt has to be
  located in root source directory and must be able to generate binary rpm
- packages by executing ``cpack -G`` command. The two executables as well as
+ packages by executing :option:`cpack -G` command. The two executables as well as
  rpmbuild must also be present when generating binary rpm packages from the
  produced SRPM package.
 

+ 3 - 3
Help/envvar/CMAKE_GENERATOR.rst

@@ -6,9 +6,9 @@ CMAKE_GENERATOR
 .. include:: ENV_VAR.txt
 
 Specifies the CMake default generator to use when no generator is supplied
-with ``-G``. If the provided value doesn't name a generator known by CMake,
-the internal default is used.  Either way the resulting generator selection
-is stored in the :variable:`CMAKE_GENERATOR` variable.
+with :option:`-G <cmake -G>`. If the provided value doesn't name a generator
+known by CMake, the internal default is used.  Either way the resulting
+generator selection is stored in the :variable:`CMAKE_GENERATOR` variable.
 
 Some generators may be additionally configured using the environment
 variables:

+ 3 - 3
Help/guide/user-interaction/index.rst

@@ -153,7 +153,7 @@ platform.  Usually, the default generator is sufficient
 to allow the user to proceed to build the software.
 
 The user may override the default generator with
-the ``-G`` option:
+the :option:`-G <cmake -G>` option:
 
 .. code-block:: console
 
@@ -214,8 +214,8 @@ generator to use, typically a choice between a ``Makefile``
 or a ``Ninja`` based generator.
 
 Note that it is not possible to change the generator
-with ``-G`` after the first invocation of CMake.  To
-change the generator, the build directory must be
+with :option:`-G <cmake -G>` after the first invocation of CMake.
+To change the generator, the build directory must be
 deleted and the build must be started from scratch.
 
 When generating Visual Studio project and solutions

+ 2 - 2
Help/manual/cmake-generators.7.rst

@@ -19,8 +19,8 @@ produce project files for an auxiliary IDE.
 
 CMake Generators are platform-specific so each may be available only
 on certain platforms.  The :manual:`cmake(1)` command-line tool ``--help``
-output lists available generators on the current platform.  Use its ``-G``
-option to specify the generator for a new build tree.
+output lists available generators on the current platform.  Use its
+:option:`-G <cmake -G>` option to specify the generator for a new build tree.
 The :manual:`cmake-gui(1)` offers interactive selection of a generator
 when creating a new build tree.
 

+ 3 - 3
Help/manual/cmake-presets.7.rst

@@ -198,9 +198,9 @@ that may contain the following fields:
   or above, this field may be omitted to fall back to regular generator
   discovery procedure.
 
-  Note that for Visual Studio generators, unlike in the command line ``-G``
-  argument, you cannot include the platform name in the generator name. Use
-  the ``architecture`` field instead.
+  Note that for Visual Studio generators, unlike in the command line
+  :option:`-G <cmake -G>` argument, you cannot include the platform name
+  in the generator name. Use the ``architecture`` field instead.
 
 ``architecture``, ``toolset``
 

+ 8 - 7
Modules/CPack.cmake

@@ -53,9 +53,9 @@ Here's how it works:
 
 * :manual:`cpack <cpack(1)>` runs
 * it includes ``CPackConfig.cmake``
-* it iterates over the generators given by the ``-G`` command line option,
-  or if no such option was specified, over the list of generators given by
-  the :variable:`CPACK_GENERATOR` variable set in the ``CPackConfig.cmake``
+* it iterates over the generators given by the :option:`-G <cpack -G>` command
+  line option, or if no such option was specified, over the list of generators
+  given by the :variable:`CPACK_GENERATOR` variable set in the ``CPackConfig.cmake``
   input file.
 * foreach generator, it then
 
@@ -246,9 +246,9 @@ installers.  The most commonly-used variables are:
   List of CPack generators to use.  If not specified, CPack will create a
   set of options following the naming pattern
   :variable:`CPACK_BINARY_<GENNAME>` (e.g. ``CPACK_BINARY_NSIS``) allowing
-  the user to enable/disable individual generators.  If the ``-G`` option is
-  given on the :manual:`cpack <cpack(1)>` command line, it will override this
-  variable and any ``CPACK_BINARY_<GENNAME>`` options.
+  the user to enable/disable individual generators.  If the :option:`-G <cpack -G>`
+  option is given on the :manual:`cpack <cpack(1)>` command line, it will override
+  this variable and any ``CPACK_BINARY_<GENNAME>`` options.
 
 .. variable:: CPACK_OUTPUT_CONFIG_FILE
 
@@ -469,7 +469,8 @@ The following variables are for advanced uses of CPack:
   generates (when :variable:`CPACK_GENERATOR` is not set) a set of CMake
   options (see CMake :command:`option` command) which may then be used to
   select the CPack generator(s) to be used when building the ``package``
-  target or when running :manual:`cpack <cpack(1)>` without the ``-G`` option.
+  target or when running :manual:`cpack <cpack(1)>` without the
+  :option:`-G <cpack -G>` option.
 
 #]=======================================================================]