diff options
author | Brad King <brad.king@kitware.com> | 2011-01-17 14:14:35 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2011-01-17 14:14:35 (GMT) |
commit | 0d7cf4951a5f3e375096ba4426a6cb503266f9df (patch) | |
tree | 7a7d18b635a3f31a128222f43babfa7b9b1a3619 /Source | |
parent | 6b084f1e0469a84eebfa6c849ac2a4445a9e2438 (diff) | |
download | CMake-0d7cf4951a5f3e375096ba4426a6cb503266f9df.zip CMake-0d7cf4951a5f3e375096ba4426a6cb503266f9df.tar.gz CMake-0d7cf4951a5f3e375096ba4426a6cb503266f9df.tar.bz2 |
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.
Diffstat (limited to 'Source')
-rw-r--r-- | Source/cmGetCMakePropertyCommand.h | 7 | ||||
-rw-r--r-- | Source/cmGetTestPropertyCommand.h | 8 |
2 files changed, 8 insertions, 7 deletions
diff --git a/Source/cmGetCMakePropertyCommand.h b/Source/cmGetCMakePropertyCommand.h index c78671e..acbbfee 100644 --- a/Source/cmGetCMakePropertyCommand.h +++ b/Source/cmGetCMakePropertyCommand.h @@ -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."; } diff --git a/Source/cmGetTestPropertyCommand.h b/Source/cmGetTestPropertyCommand.h index 956cf55..2b58ab9 100644 --- a/Source/cmGetTestPropertyCommand.h +++ b/Source/cmGetTestPropertyCommand.h @@ -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"; } |