Help: Document which variable names CMake reserves.

This commit is contained in:
Robert Maynard 2020-01-29 09:43:06 -05:00 committed by Brad King
parent 1f9321c683
commit 2158ef3e44
3 changed files with 10 additions and 0 deletions

View File

@ -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)>`.

View File

@ -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

View File

@ -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
==================================