This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "CMake".
The branch, master has been updated
via 7ea18c02c388d43e09e806de16168e7090e7384d (commit)
via 42294f43bd95f1380c07a563acf3021ddd00b995 (commit)
via 9e0775cb6a4c08d2605894e9f8d09b8508cfd90d (commit)
from 56f5310112705c00e0e1ae876cfde633c04bd740 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=7ea18c02c388d43e09e806de16168e7090e7384d
commit 7ea18c02c388d43e09e806de16168e7090e7384d
Merge: 56f5310 42294f4
Author: Craig Scott <craig.sc...@crascit.com>
AuthorDate: Mon Jul 1 11:42:31 2019 +0000
Commit: Kitware Robot <kwro...@kitware.com>
CommitDate: Mon Jul 1 07:43:08 2019 -0400
Merge topic 'docs-project-code-injection'
42294f43bd Help: move code injection vars to their own section
9e0775cb6a Help: Remove self-references from project() docs
Acked-by: Kitware Robot <kwro...@kitware.com>
Merge-request: !3494
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=42294f43bd95f1380c07a563acf3021ddd00b995
commit 42294f43bd95f1380c07a563acf3021ddd00b995
Author: Craig Scott <craig.sc...@crascit.com>
AuthorDate: Sat Jun 29 22:14:57 2019 +1000
Commit: Craig Scott <craig.sc...@crascit.com>
CommitDate: Mon Jul 1 08:01:49 2019 +1000
Help: move code injection vars to their own section
The docs for CMAKE_PROJECT_<projName>_INCLUDE and
CMAKE_PROJECT_INCLUDE did not define the order of
inclusion if both were set.
diff --git a/Help/command/project.rst b/Help/command/project.rst
index 19a8999..baf18be 100644
--- a/Help/command/project.rst
+++ b/Help/command/project.rst
@@ -31,14 +31,6 @@ Further variables are set by the optional arguments
described in the following.
If any of these arguments is not used, then the corresponding variables are
set to the empty string.
-If the variable :variable:`CMAKE_PROJECT_INCLUDE_BEFORE` exists, the file
-pointed to by that variable will be included as the first step of the project
-command.
-
-If the variable :variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE`
-or :variable:`CMAKE_PROJECT_INCLUDE` exists, the file pointed to by that
-variable will be included as the last step of the project command.
-
Options
^^^^^^^
@@ -106,6 +98,19 @@ The options are:
The variables set through the ``VERSION``, ``DESCRIPTION`` and ``HOMEPAGE_URL``
options are intended for use as default values in package metadata and
documentation.
+Code Injection
+^^^^^^^^^^^^^^
+
+If the :variable:`CMAKE_PROJECT_INCLUDE_BEFORE` variable is set, the file
+pointed to by that variable will be included as the first step of the
+``project()`` command.
+
+If the :variable:`CMAKE_PROJECT_INCLUDE` or
+:variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE` variables are set, the files
+they point to will be included as the last step of the ``project()`` command.
+If both are set, then :variable:`CMAKE_PROJECT_INCLUDE` will be included before
+:variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE`.
+
Usage
^^^^^
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=9e0775cb6a4c08d2605894e9f8d09b8508cfd90d
commit 9e0775cb6a4c08d2605894e9f8d09b8508cfd90d
Author: Craig Scott <craig.sc...@crascit.com>
AuthorDate: Sat Jun 29 22:20:54 2019 +1000
Commit: Craig Scott <craig.sc...@crascit.com>
CommitDate: Sat Jun 29 22:21:18 2019 +1000
Help: Remove self-references from project() docs
diff --git a/Help/command/project.rst b/Help/command/project.rst
index 41e1112..19a8999 100644
--- a/Help/command/project.rst
+++ b/Help/command/project.rst
@@ -63,7 +63,7 @@ The options are:
* :variable:`PROJECT_VERSION_TWEAK`,
:variable:`<PROJECT-NAME>_VERSION_TWEAK`.
- When the :command:`project()` command is called from the top-level
``CMakeLists.txt``,
+ When the ``project()`` command is called from the top-level
``CMakeLists.txt``,
then the version is also stored in the variable
:variable:`CMAKE_PROJECT_VERSION`.
``DESCRIPTION <project-description-string>``
@@ -76,7 +76,7 @@ The options are:
It is recommended that this description is a relatively short string,
usually no more than a few words.
- When the :command:`project()` command is called from the top-level
``CMakeLists.txt``,
+ When the ``project()`` command is called from the top-level
``CMakeLists.txt``,
then the description is also stored in the variable
:variable:`CMAKE_PROJECT_DESCRIPTION`.
``HOMEPAGE_URL <url-string>``
@@ -87,7 +87,7 @@ The options are:
to ``<url-string>``, which should be the canonical home URL for the project.
- When the :command:`project()` command is called from the top-level
``CMakeLists.txt``,
+ When the ``project()`` command is called from the top-level
``CMakeLists.txt``,
then the URL also is stored in the variable
:variable:`CMAKE_PROJECT_HOMEPAGE_URL`.
``LANGUAGES <language-name>...``
@@ -110,14 +110,14 @@ Usage
^^^^^
The top-level ``CMakeLists.txt`` file for a project must contain a
-literal, direct call to the :command:`project` command; loading one
+literal, direct call to the ``project()`` command; loading one
through the :command:`include` command is not sufficient. If no such
call exists, CMake will issue a warning and pretend there is a
``project(Project)`` at the top to enable the default languages
(``C`` and ``CXX``).
.. note::
- Call the :command:`project()` command near the top of the top-level
+ Call the ``project()`` command near the top of the top-level
``CMakeLists.txt``, but *after* calling :command:`cmake_minimum_required`.
It is important to establish version and policy settings before invoking
other commands whose behavior they may affect.
-----------------------------------------------------------------------
Summary of changes:
Help/command/project.rst | 31 ++++++++++++++++++-------------
1 file changed, 18 insertions(+), 13 deletions(-)
hooks/post-receive
--
CMake
_______________________________________________
Cmake-commits mailing list
Cmake-commits@cmake.org
https://cmake.org/mailman/listinfo/cmake-commits
