summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-06-26 12:41:51 (GMT)
committerBrad King <brad.king@kitware.com>2013-06-26 12:41:51 (GMT)
commitc293e05b8e6093151dcebd6e5bd76840ac4f5e89 (patch)
tree190e381769a0292b3ad7be4640a6455075e2a18a
parentfdd558d6a6d630d4b0b1f6e84875b3f98fbc0e67 (diff)
downloadCMake-c293e05b8e6093151dcebd6e5bd76840ac4f5e89.zip
CMake-c293e05b8e6093151dcebd6e5bd76840ac4f5e89.tar.gz
CMake-c293e05b8e6093151dcebd6e5bd76840ac4f5e89.tar.bz2
Document ENV syntax as a "variable" (#14245)
Although "ENV" is not a special variable itself, use it to document the $ENV{VAR} syntax.
-rw-r--r--Source/cmDocumentVariables.cxx8
1 files changed, 8 insertions, 0 deletions
diff --git a/Source/cmDocumentVariables.cxx b/Source/cmDocumentVariables.cxx
index ed51c47..7f5c8ad 100644
--- a/Source/cmDocumentVariables.cxx
+++ b/Source/cmDocumentVariables.cxx
@@ -1180,6 +1180,14 @@ void cmDocumentVariables::DefineVariables(cmake* cm)
"The value must be an integer no less than 128.",false,
"Variables That Describe the System");
+ cm->DefineProperty
+ ("ENV", cmProperty::VARIABLE,
+ "Access environment variables.",
+ "Use the syntax $ENV{VAR} to read environment variable VAR. "
+ "See also the set() command to set ENV{VAR}."
+ ,false,
+ "Variables That Describe the System");
+
// Variables that affect the building of object files and
// targets.
//