From 2158ef3e44ce4f29dc4776d6c5d35a90c2ee87e5 Mon Sep 17 00:00:00 2001 From: Robert Maynard Date: Wed, 29 Jan 2020 09:43:06 -0500 Subject: Help: Document which variable names CMake reserves. --- Help/manual/ID_RESERVE.txt | 7 +++++++ Help/manual/cmake-language.7.rst | 2 ++ Help/manual/cmake-variables.7.rst | 1 + 3 files changed, 10 insertions(+) create mode 100644 Help/manual/ID_RESERVE.txt 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 `. 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 ` section in the cmake-language manual. +.. include:: ID_RESERVE.txt Variables that Provide Information ================================== -- cgit v0.12