kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix get_(cmake|test)_property documentation (#11703) 

The signature of get_test_property uses argument order

  test property VAR

not

  test VAR property

Also document the actual behavior when the property is not found.
This commit is contained in:
Brad King 2011-01-17 09:14:35 -05:00
parent 6b084f1e04
commit 0d7cf4951a
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Source/cmGetCMakePropertyCommand.h
View File

@ -54,9 +54,10 @@ public:
{
return
" get_cmake_property(VAR property)\n"
"Get a property from the CMake instance. The value of the "
"property is stored in the variable VAR. If the property is "
"not found, CMake will report an error. Some supported properties "
"Get a property from the CMake instance. "
"The value of the property is stored in the variable VAR. "
"If the property is not found, VAR will be set to \"NOTFOUND\". "
"Some supported properties "
"include: VARIABLES, CACHE_VARIABLES, COMMANDS, MACROS, and "
"COMPONENTS.";
}

8
Source/cmGetTestPropertyCommand.h
View File

@ -48,10 +48,10 @@ public:
virtual const char* GetFullDocumentation()
{
return
" get_test_property(test VAR property)\n"
"Get a property from the Test. The value of the property is "
"stored in the variable VAR. If the property is not found, "
"CMake will report an error. For a list of standard properties "
" get_test_property(test property VAR)\n"
"Get a property from the Test. The value of the property is "
"stored in the variable VAR. If the property is not found, VAR "
"will be set to \"NOTFOUND\". For a list of standard properties "
"you can type cmake --help-property-list";
}