summaryrefslogtreecommitdiffstats
path: root/Help/command/subdirs.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Help/command/subdirs.rst')
-rw-r--r--Help/command/subdirs.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/Help/command/subdirs.rst b/Help/command/subdirs.rst
index dee49f8..43b87d4 100644
--- a/Help/command/subdirs.rst
+++ b/Help/command/subdirs.rst
@@ -1,7 +1,7 @@
subdirs
-------
-Deprecated. Use the add_subdirectory() command instead.
+Deprecated. Use the :command:`add_subdirectory` command instead.
Add a list of subdirectories to the build.
@@ -10,12 +10,12 @@ Add a list of subdirectories to the build.
subdirs(dir1 dir2 ...[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...]
[PREORDER] )
-Add a list of subdirectories to the build. The add_subdirectory
-command should be used instead of subdirs although subdirs will still
+Add a list of subdirectories to the build. The :command:`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 PREORDER flag has no effect on
-IDE projects. Any directories after the EXCLUDE_FROM_ALL marker will
+to be processed by CMake. Any directories after the ``PREORDER`` flag 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 generate makefiles or