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

ENH: Clarified documentation of the command.

This commit is contained in:
Brad King 2005-03-25 16:40:28 -05:00
parent 888d5f2f47
commit 8cb981b176
1 changed files with 27 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
Source/cmAddSubDirectoryCommand.h
View File

@ -62,22 +62,34 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
" ADD_SUBDIRECTORY(binary_dir [source_dir] [EXCLUDE_FROM_ALL] [PREORDER] )\n" " ADD_SUBDIRECTORY(binary_dir [source_dir]\n"
"Add a subdirectory to the build. The binary_dir specified can be " " [EXCLUDE_FROM_ALL] [PREORDER])\n"
"relative to the current otuput directory (the typical usage) or " "Add a subdirectory to the build. The binary_dir specifies the "
"absolute. If the source dir is not specified it " "directory in which to store the build files. If it is a relative "
"will be set to the same value as the binary_dir. " "path it will be evaluated with respect to the current output "
"This will cause any CMakeLists.txt files in the sub directories " "directory (the typical usage), but it may also be an absolute path. "
"to be processed by CMake. If the PREORDER flag " "The source_dir specifies the directory in which to find the source "
"is specified then this directory will be traversed first by makefile " "files. If it is a relative path it will be evaluated with respect "
"builds, the PRORDER flag has no effect on IDE projects. " "to the current source directory, but it may also be an absolute "
"path. If source_dir is not specified the value of binary_dir, "
"before expanding any relative path, will be used (the typical usage). "
"The CMakeLists.txt file in the specified source directory will "
"be processed immediately by CMake before processing in the current "
"input file continues beyond this command.\n"
"The PREORDER flag tells recursive makefile generators to build "
"targets in the subdirectory before those in the current directory. "
"If this flag is not specified then the targets in the current "
"directory are always built first. The PREORDER flag has no meaning "
"for global build system generators.\n"
"If the EXCLUDE_FROM_ALL argument is provided then this subdirectory " "If the EXCLUDE_FROM_ALL argument is provided then this subdirectory "
"will not be included in the top level makefile or project file. " "will not be included in build by default. Users will have to "
"This is useful for having cmake create makefiles or projects for a " "explicitly start a build in the generated output directory. "
"set of examples in a project. You would want cmake to generated " "This is useful for having cmake create a build system for a "
"makefiles or project files for all the examples at the same time, " "set of examples in a project. One would want cmake to generate "
"but you would not want them to show up in the top level project or " "a single build system for all the examples, but one may not want "
"be built each time make is run from the top."; "the targets to show up in the main build system.";
} }
cmTypeMacro(cmAddSubDirectoryCommand, cmCommand); cmTypeMacro(cmAddSubDirectoryCommand, cmCommand);