diff options
| author | Brad King <brad.king@kitware.com> | 2020-01-30 14:50:49 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2020-01-30 14:51:03 (GMT) |
| commit | f274729c1234b54d947ce6fdb256cf5d5c8b031b (patch) | |
| tree | daca2f42ceaf2234f1262a19370d07f1c7aa4e0d /Help/manual | |
| parent | 7dd5ca66c911a422878f53d998eb457297eaf804 (diff) | |
| parent | 2158ef3e44ce4f29dc4776d6c5d35a90c2ee87e5 (diff) | |
| download | CMake-f274729c1234b54d947ce6fdb256cf5d5c8b031b.zip CMake-f274729c1234b54d947ce6fdb256cf5d5c8b031b.tar.gz CMake-f274729c1234b54d947ce6fdb256cf5d5c8b031b.tar.bz2 | |
Merge topic 'document_cmake_reserved_names'
2158ef3e44 Help: Document which variable names CMake reserves.
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4298
Diffstat (limited to 'Help/manual')
| -rw-r--r-- | Help/manual/ID_RESERVE.txt | 7 | ||||
| -rw-r--r-- | Help/manual/cmake-language.7.rst | 2 | ||||
| -rw-r--r-- | Help/manual/cmake-variables.7.rst | 1 |
3 files changed, 10 insertions, 0 deletions
diff --git a/Help/manual/ID_RESERVE.txt b/Help/manual/ID_RESERVE.txt new file mode 100644 index 0000000..be2b163 --- /dev/null +++ b/Help/manual/ID_RESERVE.txt @@ -0,0 +1,7 @@ +.. note:: + + CMake reserves identifiers that: + + * begin with ``CMAKE_`` (upper-, lower-, or mixed-case), or + * begin with ``_CMAKE_`` (upper-, lower-, or mixed-case), or + * begin with ``_`` followed by the name of any :manual:`CMake Command <cmake-commands(7)>`. diff --git a/Help/manual/cmake-language.7.rst b/Help/manual/cmake-language.7.rst index 4ca8e3a..b7f0861 100644 --- a/Help/manual/cmake-language.7.rst +++ b/Help/manual/cmake-language.7.rst @@ -567,6 +567,8 @@ The :manual:`cmake-variables(7)` manual documents the many variables that are provided by CMake or have meaning to CMake when set by project code. +.. include:: ID_RESERVE.txt + .. _`CMake Language Environment Variables`: Environment Variables diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst index 63deda5..1bcd9bd 100644 --- a/Help/manual/cmake-variables.7.rst +++ b/Help/manual/cmake-variables.7.rst @@ -14,6 +14,7 @@ For general information on variables, see the :ref:`Variables <CMake Language Variables>` section in the cmake-language manual. +.. include:: ID_RESERVE.txt Variables that Provide Information ================================== |