diff options
author | Alex Turbov <i.zaufi@gmail.com> | 2022-11-06 00:05:00 (GMT) |
---|---|---|
committer | Alex Turbov <i.zaufi@gmail.com> | 2022-11-06 00:28:21 (GMT) |
commit | 029210730a6b87629d937e6e5037dc2302010fc8 (patch) | |
tree | 5d00c6dcfc0e3133ff69e3a5cf7ff2a945ebaf12 /Modules | |
parent | 295062ef4b3ae630c2d2a19baba1da41c28ac229 (diff) | |
download | CMake-029210730a6b87629d937e6e5037dc2302010fc8.zip CMake-029210730a6b87629d937e6e5037dc2302010fc8.tar.gz CMake-029210730a6b87629d937e6e5037dc2302010fc8.tar.bz2 |
Help: Use role `:program:`
When mention execitable names use Sphinx semantic role `:program`
instead of ``executable`` or **executable**.
Diffstat (limited to 'Modules')
-rw-r--r-- | Modules/CPack.cmake | 2 | ||||
-rw-r--r-- | Modules/ExternalProject.cmake | 12 | ||||
-rw-r--r-- | Modules/FetchContent.cmake | 2 | ||||
-rw-r--r-- | Modules/GoogleTest.cmake | 2 |
4 files changed, 9 insertions, 9 deletions
diff --git a/Modules/CPack.cmake b/Modules/CPack.cmake index 7c3ad6b..f9cf33f 100644 --- a/Modules/CPack.cmake +++ b/Modules/CPack.cmake @@ -262,7 +262,7 @@ installers. The most commonly-used variables are: Lists each of the executables and associated text label to be used to create Start Menu shortcuts. For example, setting this to the list ``ccmake;CMake`` will create a shortcut named "CMake" that will execute the - installed executable ``ccmake``. Not all CPack generators use it (at least + installed executable :program:`ccmake`. Not all CPack generators use it (at least NSIS, and WIX do). .. variable:: CPACK_STRIP_FILES diff --git a/Modules/ExternalProject.cmake b/Modules/ExternalProject.cmake index 141b185..f7b9399 100644 --- a/Modules/ExternalProject.cmake +++ b/Modules/ExternalProject.cmake @@ -525,9 +525,9 @@ External Project Definition option without the ``CMAKE_GENERATOR`` option. ``CMAKE_ARGS <arg>...`` - The specified arguments are passed to the ``cmake`` command line. They - can be any argument the ``cmake`` command understands, not just cache - values defined by ``-D...`` arguments (see also + The specified arguments are passed to the :program:`cmake` command line. + They can be any argument the :program:`cmake` command understands, not just + cache values defined by ``-D...`` arguments (see also :manual:`CMake Options <cmake(1)>`). .. versionadded:: 3.3 @@ -611,9 +611,9 @@ External Project Definition supported). If this option is not given, the default build command will be chosen to integrate with the main build in the most appropriate way (e.g. using recursive ``make`` for Makefile generators or - ``cmake --build`` if the project uses a CMake build). This option can be - specified with an empty string as the command to make the build step do - nothing. + :option:`cmake --build` if the project uses a CMake build). This option + can be specified with an empty string as the command to make the build + step do nothing. ``BUILD_IN_SOURCE <bool>`` When this option is enabled, the build will be done directly within the diff --git a/Modules/FetchContent.cmake b/Modules/FetchContent.cmake index ac3918c..9acd0db 100644 --- a/Modules/FetchContent.cmake +++ b/Modules/FetchContent.cmake @@ -1047,7 +1047,7 @@ directory. The :variable:`CMAKE_TOOLCHAIN_FILE` variable is not used until the :command:`project` command is reached, at which point CMake looks for the named toolchain file relative to the build directory. Because the tarball has already been downloaded and unpacked by then, the toolchain file will be in -place, even the very first time that ``cmake`` is run in the build directory. +place, even the very first time that :program:`cmake` is run in the build directory. Populating Content In CMake Script Mode """"""""""""""""""""""""""""""""""""""" diff --git a/Modules/GoogleTest.cmake b/Modules/GoogleTest.cmake index b8dc482..cb165eb 100644 --- a/Modules/GoogleTest.cmake +++ b/Modules/GoogleTest.cmake @@ -212,7 +212,7 @@ same as the Google Test name (i.e. ``suite.testcase``); see also discovery. Note that the expression is a wildcard-based format that matches against the original test names as used by gtest. For type or value-parameterized tests, these names may be different to the potentially - pretty-printed test names that ``ctest`` uses. + pretty-printed test names that :program:`ctest` uses. ``NO_PRETTY_TYPES`` By default, the type index of type-parameterized tests is replaced by the |