diff options
| author | Brad King <brad.king@kitware.com> | 2019-06-17 11:06:07 -0400 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2019-06-17 11:06:07 -0400 |
| commit | 8a08d0c0926a9f950ff49d5547b374c0bd282440 (patch) | |
| tree | dbf49ba241a495f5f28195ba728cee7347367c05 | |
| parent | a4231943117f5ba3dd0fdc6c8b1824334162b69f (diff) | |
| download | cmake-8a08d0c0926a9f950ff49d5547b374c0bd282440.tar.gz | |
Help: Document what project() calls use CMAKE_PROJECT_INCLUDE and friends
Fixes: #19340
| -rw-r--r-- | Help/variable/CMAKE_PROJECT_INCLUDE.rst | 9 | ||||
| -rw-r--r-- | Help/variable/CMAKE_PROJECT_INCLUDE_BEFORE.rst | 9 | ||||
| -rw-r--r-- | Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE.rst | 10 |
3 files changed, 19 insertions, 9 deletions
diff --git a/Help/variable/CMAKE_PROJECT_INCLUDE.rst b/Help/variable/CMAKE_PROJECT_INCLUDE.rst index 7de767a373..965c94ee7c 100644 --- a/Help/variable/CMAKE_PROJECT_INCLUDE.rst +++ b/Help/variable/CMAKE_PROJECT_INCLUDE.rst @@ -1,6 +1,9 @@ CMAKE_PROJECT_INCLUDE --------------------- -A CMake language file or module to be included by the :command:`project` -command. This is intended for injecting custom code into project -builds without modifying their source. +A CMake language file or module to be included as the last step of all +:command:`project` command calls. This is intended for injecting custom code +into project builds without modifying their source. + +See also the :variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE` and +:variable:`CMAKE_PROJECT_INCLUDE_BEFORE` variables. diff --git a/Help/variable/CMAKE_PROJECT_INCLUDE_BEFORE.rst b/Help/variable/CMAKE_PROJECT_INCLUDE_BEFORE.rst index 12a5263e99..70b15e662f 100644 --- a/Help/variable/CMAKE_PROJECT_INCLUDE_BEFORE.rst +++ b/Help/variable/CMAKE_PROJECT_INCLUDE_BEFORE.rst @@ -1,6 +1,9 @@ CMAKE_PROJECT_INCLUDE_BEFORE ---------------------------- -A CMake language file or module to be included before processing the -:command:`project` command. This is intended for injecting custom code into -project builds without modifying their source. +A CMake language file or module to be included as the first step of all +:command:`project` command calls. This is intended for injecting custom code +into project builds without modifying their source. + +See also the :variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE` and +:variable:`CMAKE_PROJECT_INCLUDE` variables. diff --git a/Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE.rst b/Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE.rst index 5ca40a361b..3485c38e44 100644 --- a/Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE.rst +++ b/Help/variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE.rst @@ -1,6 +1,10 @@ CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE ------------------------------------ -A CMake language file or module to be included by the :command:`project` -command. This is intended for injecting custom code into project -builds without modifying their source. +A CMake language file or module to be included as the last step of any +:command:`project` command calls that specify ``<PROJECT-NAME>`` as the project +name. This is intended for injecting custom code into project builds without +modifying their source. + +See also the :variable:`CMAKE_PROJECT_INCLUDE` and +:variable:`CMAKE_PROJECT_INCLUDE_BEFORE` variables. |