summaryrefslogtreecommitdiffstats
path: root/Help/command/add_subdirectory.rst
diff options
context:
space:
mode:
authorMichael Scott <michael.scott250@gmail.com>2015-06-04 21:51:22 (GMT)
committerBrad King <brad.king@kitware.com>2015-06-08 20:28:31 (GMT)
commitc3f40f4fd98388a2fd31c707e7225d33a7fc76f6 (patch)
tree4b76a32ab9bf416fe1b5d5bd60bc68e1f267b3a7 /Help/command/add_subdirectory.rst
parentd17aa60659a1a69f9101c61a149eca5842291226 (diff)
downloadCMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.zip
CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.gz
CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.bz2
Help: Improve formatting of command documentation
Use inline reStructuredText markup and add cross-references in more places.
Diffstat (limited to 'Help/command/add_subdirectory.rst')
-rw-r--r--Help/command/add_subdirectory.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/Help/command/add_subdirectory.rst b/Help/command/add_subdirectory.rst
index 29b5017..e979253 100644
--- a/Help/command/add_subdirectory.rst
+++ b/Help/command/add_subdirectory.rst
@@ -12,23 +12,23 @@ Add a subdirectory to the build. The source_dir specifies the
directory in which the source CMakeLists.txt and code files are
located. If it is a relative path it will be evaluated with respect
to the current directory (the typical usage), but it may also be an
-absolute path. The binary_dir specifies the directory in which to
+absolute path. The ``binary_dir`` specifies the directory in which to
place the output files. If it is a relative path it will be evaluated
with respect to the current output directory, but it may also be an
-absolute path. If binary_dir is not specified, the value of
-source_dir, before expanding any relative path, will be used (the
+absolute path. If ``binary_dir`` is not specified, the value of
+``source_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.
-If the EXCLUDE_FROM_ALL argument is provided then targets in the
-subdirectory will not be included in the ALL target of the parent
+If the ``EXCLUDE_FROM_ALL`` argument is provided then targets in the
+subdirectory will not be included in the ``ALL`` target of the parent
directory by default, and will be excluded from IDE project files.
Users must explicitly build targets in the subdirectory. This is
meant for use when the subdirectory contains a separate part of the
project that is useful but not necessary, such as a set of examples.
-Typically the subdirectory should contain its own project() command
-invocation so that a full build system will be generated in the
+Typically the subdirectory should contain its own :command:`project`
+command invocation so that a full build system will be generated in the
subdirectory (such as a VS IDE solution file). Note that inter-target
dependencies supercede this exclusion. If a target built by the
parent project depends on a target in the subdirectory, the dependee