summaryrefslogtreecommitdiffstats
path: root/Source/cmGetDirectoryPropertyCommand.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/cmGetDirectoryPropertyCommand.h')
-rw-r--r--Source/cmGetDirectoryPropertyCommand.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/Source/cmGetDirectoryPropertyCommand.h b/Source/cmGetDirectoryPropertyCommand.h
index d7b2103..0befc65 100644
--- a/Source/cmGetDirectoryPropertyCommand.h
+++ b/Source/cmGetDirectoryPropertyCommand.h
@@ -52,12 +52,16 @@ public:
virtual const char* GetFullDocumentation()
{
return
- " GET_DIRECTORY_PROPERTY(VAR property)\n"
+ " GET_DIRECTORY_PROPERTY(VAR [DIRECTORY dir] property)\n"
"Get a property from the Directory. The value of the property is"
"stored in the variable VAR. If the property is not found,"
"CMake will report an error. The properties include: VARIABLES, "
"CACHE_VARIABLES, COMMANDS, MACROS, INCLUDE_DIRECTORIES, "
- "LINK_DIRECTORIES, DEFINITIONS and INCLUDE_REGULAR_EXPRESSION.";
+ "LINK_DIRECTORIES, DEFINITIONS, INCLUDE_REGULAR_EXPRESSION and "
+ "DEFINITION varname. If the DIRECTORY argument is provided then "
+ "the property of the provided directory will be retrieved "
+ "instead of the current directory. You can only get properties "
+ "of a directory during or after it has been traversed by cmake.";
}
cmTypeMacro(cmGetDirectoryPropertyCommand, cmCommand);