mirror of
https://github.com/Kitware/CMake.git
synced 2026-04-22 22:31:18 -05:00
Merge topic 'doc-improvements'
d4d1f85297Help: Move a note about arguments and genexes into include file968224484fHelp: Drop unused `PROPERTY_GENEX` replace from `prop_tgt/INTERFACE_*` files65457e4faeHelp: Add _See Also_ sections to related CMake commandsc86ec79d07Help: Use direct refs to genexes instead of ``$<GENEX-NAME>``8c6274326dHelp: Use CMake highlighting for command synopsisc356a94512Help: Use monospaced font for a genex name in a section titlef98c8707f4Help: Use `code-block:: cmake` instead of `::` for sub-commands descriptions2ba351ca4fHelp: ``CMake`` → CMake ... Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7873
This commit is contained in:
+1
-1
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -923,9 +923,8 @@ it depends directly on projects ``projB`` and ``projC``. Both ``projB`` and
|
||||
that all five projects are available on a company git server. The
|
||||
``CMakeLists.txt`` of each project might have sections like the following:
|
||||
|
||||
*projA*:
|
||||
|
||||
.. code-block:: cmake
|
||||
:caption: *projA*
|
||||
|
||||
include(FetchContent)
|
||||
FetchContent_Declare(
|
||||
@@ -952,9 +951,9 @@ that all five projects are available on a company git server. The
|
||||
# Order is important, see notes in the discussion further below
|
||||
FetchContent_MakeAvailable(projD projB projC)
|
||||
|
||||
*projB*:
|
||||
|
||||
.. code-block:: cmake
|
||||
:caption: *projB*
|
||||
|
||||
include(FetchContent)
|
||||
FetchContent_Declare(
|
||||
@@ -970,9 +969,9 @@ that all five projects are available on a company git server. The
|
||||
|
||||
FetchContent_MakeAvailable(projD projE)
|
||||
|
||||
*projC*:
|
||||
|
||||
.. code-block:: cmake
|
||||
:caption: *projC*
|
||||
|
||||
include(FetchContent)
|
||||
FetchContent_Declare(
|
||||
@@ -1047,7 +1046,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
|
||||
"""""""""""""""""""""""""""""""""""""""
|
||||
@@ -1058,9 +1057,8 @@ firmware tarball using CMake's :manual:`script mode <cmake(1)>`. The call to
|
||||
unpacked firmware will be placed in a ``firmware`` directory below the
|
||||
current working directory.
|
||||
|
||||
*getFirmware.cmake*:
|
||||
|
||||
.. code-block:: cmake
|
||||
:caption: :file:`getFirmware.cmake`
|
||||
|
||||
# NOTE: Intended to be run in script mode with cmake -P
|
||||
include(FetchContent)
|
||||
|
||||
@@ -56,7 +56,7 @@ To manage concurrent versions 3 and 2 of Python, use :module:`FindPython3` and
|
||||
|
||||
If components ``Interpreter`` and ``Development`` (or one of its
|
||||
sub-components) are both specified, this module search only for interpreter
|
||||
with same platform architecture as the one defined by ``CMake``
|
||||
with same platform architecture as the one defined by CMake
|
||||
configuration. This constraint does not apply if only ``Interpreter``
|
||||
component is specified.
|
||||
|
||||
@@ -449,7 +449,7 @@ setting the following variables:
|
||||
|
||||
By default, this module supports multiple calls in different directories of a
|
||||
project with different version/component requirements while providing correct
|
||||
and consistent results for each call. To support this behavior, ``CMake`` cache
|
||||
and consistent results for each call. To support this behavior, CMake cache
|
||||
is not used in the traditional way which can be problematic for interactive
|
||||
specification. So, to enable also interactive specification, module behavior
|
||||
can be controlled with the following variable:
|
||||
|
||||
@@ -57,7 +57,7 @@ for you.
|
||||
|
||||
If components ``Interpreter`` and ``Development`` (or one of its
|
||||
sub-components) are both specified, this module search only for interpreter
|
||||
with same platform architecture as the one defined by ``CMake``
|
||||
with same platform architecture as the one defined by CMake
|
||||
configuration. This constraint does not apply if only ``Interpreter``
|
||||
component is specified.
|
||||
|
||||
@@ -388,7 +388,7 @@ setting the following variables:
|
||||
|
||||
By default, this module supports multiple calls in different directories of a
|
||||
project with different version/component requirements while providing correct
|
||||
and consistent results for each call. To support this behavior, ``CMake`` cache
|
||||
and consistent results for each call. To support this behavior, CMake cache
|
||||
is not used in the traditional way which can be problematic for interactive
|
||||
specification. So, to enable also interactive specification, module behavior
|
||||
can be controlled with the following variable:
|
||||
|
||||
@@ -57,7 +57,7 @@ for you.
|
||||
|
||||
If components ``Interpreter`` and ``Development`` (or one of its
|
||||
sub-components) are both specified, this module search only for interpreter
|
||||
with same platform architecture as the one defined by ``CMake``
|
||||
with same platform architecture as the one defined by CMake
|
||||
configuration. This constraint does not apply if only ``Interpreter``
|
||||
component is specified.
|
||||
|
||||
@@ -447,7 +447,7 @@ setting the following variables:
|
||||
|
||||
By default, this module supports multiple calls in different directories of a
|
||||
project with different version/component requirements while providing correct
|
||||
and consistent results for each call. To support this behavior, ``CMake`` cache
|
||||
and consistent results for each call. To support this behavior, CMake cache
|
||||
is not used in the traditional way which can be problematic for interactive
|
||||
specification. So, to enable also interactive specification, module behavior
|
||||
can be controlled with the following variable:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -7,7 +7,7 @@ UseJava
|
||||
|
||||
This file provides support for ``Java``. It is assumed that
|
||||
:module:`FindJava` has already been loaded. See :module:`FindJava` for
|
||||
information on how to load Java into your ``CMake`` project.
|
||||
information on how to load Java into your CMake project.
|
||||
|
||||
Synopsis
|
||||
^^^^^^^^
|
||||
|
||||
Reference in New Issue
Block a user