diff options
Diffstat (limited to 'Source/cmSubdirCommand.h')
-rw-r--r-- | Source/cmSubdirCommand.h | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/Source/cmSubdirCommand.h b/Source/cmSubdirCommand.h index c5fda34..fce1985 100644 --- a/Source/cmSubdirCommand.h +++ b/Source/cmSubdirCommand.h @@ -62,10 +62,15 @@ public: virtual const char* GetFullDocumentation() { return - " SUBDIRS(dir1 dir2 ...)\n" + " SUBDIRS(dir1 dir2 ...[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...])\n" "Add a list of subdirectories to the build. " "This will cause any CMakeLists.txt files in the sub directories " - "to be processed by CMake."; + "to be processed by CMake. Any directories after the EXCLUDE_FROM_ALL marker " + "will not be included in the top level makefile or project file. This is useful" + " for having cmake create makefiles or projects for a set of examples in a project." + "You would want cmake to generated makefiles or project files for all the examples at" + " the same time, but you would not want them to show up in the top level project or be built" + " each time make is run from the top."; } cmTypeMacro(cmSubdirCommand, cmCommand); |