summaryrefslogtreecommitdiff
path: root/Source/cmSubdirCommand.h
diff options
context:
space:
mode:
authorKen Martin <ken.martin@kitware.com>2005-11-17 11:20:51 -0500
committerKen Martin <ken.martin@kitware.com>2005-11-17 11:20:51 -0500
commitf6ef36d8b267d886c355876a9aac6ab73888c7de (patch)
treeded7ba5c88e5c82cd0198bf5a0dcb4102629d442 /Source/cmSubdirCommand.h
parentbb7577f4e7d32fdaf55618697f460870285a870b (diff)
downloadcmake-f6ef36d8b267d886c355876a9aac6ab73888c7de.tar.gz
STYLE: fix docs
Diffstat (limited to 'Source/cmSubdirCommand.h')
-rw-r--r--Source/cmSubdirCommand.h18
1 files changed, 11 insertions, 7 deletions
diff --git a/Source/cmSubdirCommand.h b/Source/cmSubdirCommand.h
index 020d039859..2fb8bd04f2 100644
--- a/Source/cmSubdirCommand.h
+++ b/Source/cmSubdirCommand.h
@@ -63,16 +63,20 @@ public:
{
return
" SUBDIRS(dir1 dir2 ...[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...] [PREORDER] )\n"
- "Add a list of subdirectories to the build. "
+ "Add a list of subdirectories to the build. The ADD_SUBDIRECTORY "
+ "command should be used instead of SUBDIRS although SUBDIRS will "
+ "still work. "
"This will cause any CMakeLists.txt files in the sub directories "
"to be processed by CMake. Any directories after the PREORDER flag "
- "are traversed first by makefile builds, the PRORDER flag has no effect on IDE projects. "
+ "are traversed first by makefile builds, the PREORDER flag has no "
+ "effect on IDE projects. "
" 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.";
+ "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 "
+ "generate 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);