From d25b232dee81bca67a3a1008f6c1c8ad559b89ab Mon Sep 17 00:00:00 2001 From: Alex Turbov Date: Thu, 4 Aug 2022 11:06:20 +0400 Subject: Help: Replace mentions of ``-G`` option with :option:`-G` role --- Help/cpack_gen/rpm.rst | 2 +- Help/envvar/CMAKE_GENERATOR.rst | 6 +++--- Help/guide/user-interaction/index.rst | 6 +++--- Help/manual/cmake-generators.7.rst | 4 ++-- Help/manual/cmake-presets.7.rst | 6 +++--- Modules/CPack.cmake | 15 ++++++++------- 6 files changed, 20 insertions(+), 19 deletions(-) diff --git a/Help/cpack_gen/rpm.rst b/Help/cpack_gen/rpm.rst index 0d287fc..13b7255 100644 --- a/Help/cpack_gen/rpm.rst +++ b/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. diff --git a/Help/envvar/CMAKE_GENERATOR.rst b/Help/envvar/CMAKE_GENERATOR.rst index 3488b04..596e8f3 100644 --- a/Help/envvar/CMAKE_GENERATOR.rst +++ b/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 `. 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: diff --git a/Help/guide/user-interaction/index.rst b/Help/guide/user-interaction/index.rst index 39de0e5..26b52c0 100644 --- a/Help/guide/user-interaction/index.rst +++ b/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 ` 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 ` 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 diff --git a/Help/manual/cmake-generators.7.rst b/Help/manual/cmake-generators.7.rst index 034e218..326dc71 100644 --- a/Help/manual/cmake-generators.7.rst +++ b/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 ` 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. diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst index a96c704..c834eda 100644 --- a/Help/manual/cmake-presets.7.rst +++ b/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 ` argument, you cannot include the platform name + in the generator name. Use the ``architecture`` field instead. ``architecture``, ``toolset`` diff --git a/Modules/CPack.cmake b/Modules/CPack.cmake index 4934934..07280e0 100644 --- a/Modules/CPack.cmake +++ b/Modules/CPack.cmake @@ -53,9 +53,9 @@ Here's how it works: * :manual:`cpack ` 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 ` 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_` (e.g. ``CPACK_BINARY_NSIS``) allowing - the user to enable/disable individual generators. If the ``-G`` option is - given on the :manual:`cpack ` command line, it will override this - variable and any ``CPACK_BINARY_`` options. + the user to enable/disable individual generators. If the :option:`-G ` + option is given on the :manual:`cpack ` command line, it will override + this variable and any ``CPACK_BINARY_`` 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 ` without the ``-G`` option. + target or when running :manual:`cpack ` without the + :option:`-G ` option. #]=======================================================================] -- cgit v0.12