kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
CMake/Help/command/subdirs.rst

25 lines
1.0 KiB
ReStructuredText
Raw Normal View History

Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
subdirs
-------
Help: Improve formatting of command documentation Use inline reStructuredText markup and add cross-references in more places.
2015-06-05 00:51:22 +03:00
Deprecated. Use the :command:`add_subdirectory` command instead.
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
Add a list of subdirectories to the build.
::
subdirs(dir1 dir2 ...[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...]
[PREORDER] )
Help: Improve formatting of command documentation Use inline reStructuredText markup and add cross-references in more places.
2015-06-05 00:51:22 +03:00
Add a list of subdirectories to the build. The :command:`add_subdirectory`
command should be used instead of ``subdirs`` although ``subdirs`` will still
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
work. This will cause any CMakeLists.txt files in the sub directories
Help: Improve formatting of command documentation Use inline reStructuredText markup and add cross-references in more places.
2015-06-05 00:51:22 +03:00
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
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
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.