diff options
author | Brad King <brad.king@kitware.com> | 2018-10-16 15:04:01 (GMT) |
---|---|---|
committer | Kitware Robot <kwrobot@kitware.com> | 2018-10-16 15:04:09 (GMT) |
commit | e5e59a1bc68702395ff63e301cadaee266982fc7 (patch) | |
tree | 4ff2089beb3991a63cb14fb227a94d1ba15c3a15 /Help | |
parent | 73d9d53ed0333f76e8ded6a91d34fbc43111ab27 (diff) | |
parent | 82a48226107e2ee0d073eaf521750c8354b67e41 (diff) | |
download | CMake-e5e59a1bc68702395ff63e301cadaee266982fc7.zip CMake-e5e59a1bc68702395ff63e301cadaee266982fc7.tar.gz CMake-e5e59a1bc68702395ff63e301cadaee266982fc7.tar.bz2 |
Merge topic 'document-dollar-in-varnames'
82a4822610 CMP0053: document that `$` is a valid literal variable character
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2479
Diffstat (limited to 'Help')
-rw-r--r-- | Help/manual/cmake-language.7.rst | 5 | ||||
-rw-r--r-- | Help/policy/CMP0053.rst | 4 |
2 files changed, 7 insertions, 2 deletions
diff --git a/Help/manual/cmake-language.7.rst b/Help/manual/cmake-language.7.rst index 591f73d..71649ba 100644 --- a/Help/manual/cmake-language.7.rst +++ b/Help/manual/cmake-language.7.rst @@ -391,8 +391,9 @@ inside out, e.g. ``${outer_${inner_variable}_variable}``. Literal variable references may consist of alphanumeric characters, the characters ``/_.+-``, and `Escape Sequences`_. Nested references -may be used to evaluate variables of any name. (See also policy -:policy:`CMP0053` documentation for historical considerations.) +may be used to evaluate variables of any name. See also policy +:policy:`CMP0053` documentation for historical considerations and reasons why +the ``$`` is also technically permitted but is discouraged. The `Variables`_ section documents the scope of variable names and how their values are set. diff --git a/Help/policy/CMP0053.rst b/Help/policy/CMP0053.rst index 2620a60..032b3e5 100644 --- a/Help/policy/CMP0053.rst +++ b/Help/policy/CMP0053.rst @@ -16,6 +16,10 @@ cleaned up to simplify the behavior. Specifically: * Literal ``${VAR}`` reference syntax may contain only alphanumeric characters (``A-Z``, ``a-z``, ``0-9``) and the characters ``_``, ``.``, ``/``, ``-``, and ``+``. + Note that ``$`` is technically allowed in the ``NEW`` behavior, but is + invalid for ``OLD`` behavior. This is due to an oversight during the + implementation of :policy:`CMP0053` and its use as a literal variable + reference is discouraged for this reason. Variables with other characters in their name may still be referenced indirectly, e.g. |