summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2024-03-18 17:59:37 (GMT)
committerKitware Robot <kwrobot@kitware.com>2024-03-18 17:59:52 (GMT)
commit8a40da1b711db7065e53b50676b3757e9d5f0b1d (patch)
tree4683e29efe006a92ab705c1d64a2ecbcf53592e3 /Help
parent788c2047883d64f16122c155f1c86a43dcd35970 (diff)
parentdcb894fb00d4279c429934e1909f5d5d11741f9e (diff)
downloadCMake-8a40da1b711db7065e53b50676b3757e9d5f0b1d.zip
CMake-8a40da1b711db7065e53b50676b3757e9d5f0b1d.tar.gz
CMake-8a40da1b711db7065e53b50676b3757e9d5f0b1d.tar.bz2
Merge topic 'doc-project-include-vars-3.29' into release-3.29
dcb894fb00 Help: Update project() code injection for new 3.29 include behavior 09cf39ab07 Help: Improve wording of CMAKE_PROJECT_..._INCLUDE... changes for 3.29 Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !9343
Diffstat (limited to 'Help')
-rw-r--r--Help/command/project.rst12
-rw-r--r--Help/variable/CMAKE_PROJECT_INCLUDE.rst3
-rw-r--r--Help/variable/CMAKE_PROJECT_INCLUDE_BEFORE.rst3
-rw-r--r--Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE.rst3
-rw-r--r--Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE_BEFORE.rst3
5 files changed, 14 insertions, 10 deletions
diff --git a/Help/command/project.rst b/Help/command/project.rst
index d695789..2b93880 100644
--- a/Help/command/project.rst
+++ b/Help/command/project.rst
@@ -123,12 +123,12 @@ The following outlines the steps performed during a ``project()`` call:
* .. versionadded:: 3.15
For every ``project()`` call regardless of the project
- name, include the file named by :variable:`CMAKE_PROJECT_INCLUDE_BEFORE`,
- if set.
+ name, include the file(s) and module(s) named by
+ :variable:`CMAKE_PROJECT_INCLUDE_BEFORE`, if set.
* .. versionadded:: 3.17
If the ``project()`` command specifies ``<PROJECT-NAME>`` as its project
- name, include the file named by
+ name, include the file(s) and module(s) named by
:variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE`, if set.
* Set the various project-specific variables detailed in the `Synopsis`_
@@ -156,11 +156,11 @@ The following outlines the steps performed during a ``project()`` call:
* .. versionadded:: 3.15
For every ``project()`` call regardless of the project
- name, include the file named by :variable:`CMAKE_PROJECT_INCLUDE`,
- if set.
+ name, include the file(s) and module(s) named by
+ :variable:`CMAKE_PROJECT_INCLUDE`, if set.
* If the ``project()`` command specifies ``<PROJECT-NAME>`` as its project
- name, include the file named by
+ name, include the file(s) and module(s) named by
:variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE`, if set.
Usage
diff --git a/Help/variable/CMAKE_PROJECT_INCLUDE.rst b/Help/variable/CMAKE_PROJECT_INCLUDE.rst
index 217604f..e3b07d0 100644
--- a/Help/variable/CMAKE_PROJECT_INCLUDE.rst
+++ b/Help/variable/CMAKE_PROJECT_INCLUDE.rst
@@ -12,7 +12,8 @@ for a more detailed discussion of files potentially included during a
.. versionadded:: 3.29
This variable can be a :ref:`semicolon-separated list <CMake Language Lists>`
of CMake language files to be included sequentially. It can also now refer to
- module names to be found in :variable:`CMAKE_MODULE_PATH` or builtin to CMake.
+ module names to be found in :variable:`CMAKE_MODULE_PATH` or as a builtin
+ CMake module.
See also the :variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE`,
:variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE`,
diff --git a/Help/variable/CMAKE_PROJECT_INCLUDE_BEFORE.rst b/Help/variable/CMAKE_PROJECT_INCLUDE_BEFORE.rst
index 1dc0241..48da906 100644
--- a/Help/variable/CMAKE_PROJECT_INCLUDE_BEFORE.rst
+++ b/Help/variable/CMAKE_PROJECT_INCLUDE_BEFORE.rst
@@ -12,7 +12,8 @@ for a more detailed discussion of files potentially included during a
.. versionadded:: 3.29
This variable can be a :ref:`semicolon-separated list <CMake Language Lists>`
of CMake language files to be included sequentially. It can also now refer to
- module names to be found in :variable:`CMAKE_MODULE_PATH` or builtin to CMake.
+ module names to be found in :variable:`CMAKE_MODULE_PATH` or as a builtin
+ CMake module.
See also the :variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE`,
:variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE`,
diff --git a/Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE.rst b/Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE.rst
index 6d37c1a..7e2e1bb 100644
--- a/Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE.rst
+++ b/Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE.rst
@@ -10,7 +10,8 @@ discussion of files potentially included during a :command:`project` call.
.. versionadded:: 3.29
This variable can be a :ref:`semicolon-separated list <CMake Language Lists>`
of CMake language files to be included sequentially. It can also now refer to
- module names to be found in :variable:`CMAKE_MODULE_PATH` or builtin to CMake.
+ module names to be found in :variable:`CMAKE_MODULE_PATH` or as a builtin
+ CMake module.
See also the :variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE`,
:variable:`CMAKE_PROJECT_INCLUDE`, :variable:`CMAKE_PROJECT_INCLUDE_BEFORE`,
diff --git a/Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE_BEFORE.rst b/Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE_BEFORE.rst
index 96ddbf6..59ac1b0 100644
--- a/Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE_BEFORE.rst
+++ b/Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE_BEFORE.rst
@@ -12,7 +12,8 @@ discussion of files potentially included during a :command:`project` call.
.. versionadded:: 3.29
This variable can be a :ref:`semicolon-separated list <CMake Language Lists>`
of CMake language files to be included sequentially. It can also now refer to
- module names to be found in :variable:`CMAKE_MODULE_PATH` or builtin to CMake.
+ module names to be found in :variable:`CMAKE_MODULE_PATH` or as a builtin
+ CMake module.
See also the :variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE`,
:variable:`CMAKE_PROJECT_INCLUDE`, :variable:`CMAKE_PROJECT_INCLUDE_BEFORE`,