summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2019-06-29 22:14:57 +1000
committerCraig Scott <craig.scott@crascit.com>2019-07-01 08:01:49 +1000
commit42294f43bd95f1380c07a563acf3021ddd00b995 (patch)
tree600ddfd7ab835abfdb8f37ff980c0ddbf1189118
parent9e0775cb6a4c08d2605894e9f8d09b8508cfd90d (diff)
downloadcmake-42294f43bd95f1380c07a563acf3021ddd00b995.tar.gz
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.
-rw-r--r--Help/command/project.rst21
1 files changed, 13 insertions, 8 deletions
diff --git a/Help/command/project.rst b/Help/command/project.rst
index 19a8999029..baf18be644 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
^^^^^