mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-03-13 21:09:59 -05:00
Code Issues Packages Projects Releases Wiki Activity

Help: Document cmake source and binary dir selection rules

Browse Source 
Co-authored-by: Brad King <brad.king@kitware.com>
This commit is contained in:
Robert Maynard
2022-03-15 14:13:00 -04:00
committed by Brad King
parent b2ba662ca6
commit fea270d3ed
1 changed files with 20 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
Help/manual/cmake.1.rst
View File

@@ -151,6 +151,26 @@ source and build trees and generate a buildsystem:
In all cases the ``<options>`` may be zero or more of the `Options`_ below.
The above styles for specifying the source and build trees may be mixed.
Paths specified with ``-S`` or ``-B`` are always classified as source or
build trees, respectively. Paths specified with plain arguments are
classified based on their content and the types of paths given earlier.
If only one type of path is given, the current working directory (cwd)
is used for the other. For example:
============================== ============ ===========
Command Line Source Dir Build Dir
============================== ============ ===========
``cmake src`` ``src`` `cwd`
``cmake build`` (existing) `loaded` ``build``
``cmake -S src`` ``src`` `cwd`
``cmake -S src build`` ``src`` ``build``
``cmake -S src -B build`` ``src`` ``build``
``cmake -B build`` `cwd` ``build``
``cmake -B build src`` ``src`` ``build``
``cmake -B build -S src`` ``src`` ``build``
============================== ============ ===========
After generating a buildsystem one may use the corresponding native
build tool to build the project. For example, after using the
:generator:`Unix Makefiles` generator one may run ``make`` directly: