summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorRobert Maynard <robert.maynard@kitware.com>2018-09-06 14:13:39 (GMT)
committerRobert Maynard <robert.maynard@kitware.com>2018-09-15 15:25:47 (GMT)
commita10d63d5783275f9972aaa86d41071a1ddca7921 (patch)
treef1791bda0cccaaec3cd53e19e3e82cf68b44e197 /Help
parent6d2a2fe66027b6eeb2817a8e667894ad2e233d03 (diff)
downloadCMake-a10d63d5783275f9972aaa86d41071a1ddca7921.zip
CMake-a10d63d5783275f9972aaa86d41071a1ddca7921.tar.gz
CMake-a10d63d5783275f9972aaa86d41071a1ddca7921.tar.bz2
cmake: -S and -B can be used to specify source and build directories
Document the previously internal option of '-B' and provide a matching source directory option with '-S'. Both '-B', and '-S' can be used independently of each other.
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/OPTIONS_BUILD.txt8
-rw-r--r--Help/manual/cmake.1.rst1
2 files changed, 9 insertions, 0 deletions
diff --git a/Help/manual/OPTIONS_BUILD.txt b/Help/manual/OPTIONS_BUILD.txt
index 33d27af..baa73d5 100644
--- a/Help/manual/OPTIONS_BUILD.txt
+++ b/Help/manual/OPTIONS_BUILD.txt
@@ -1,3 +1,11 @@
+``-S <path-to-source>``
+ Path to root directory of the CMake project to build.
+
+``-B <path-to-build>``
+ Path to directory which CMake will use as the root of build directory.
+
+ If the directory doesn't already exist CMake will make it.
+
``-C <initial-cache>``
Pre-load a script to populate the cache.
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index 177acd4..9fe0c0b 100644
--- a/Help/manual/cmake.1.rst
+++ b/Help/manual/cmake.1.rst
@@ -9,6 +9,7 @@ Synopsis
.. parsed-literal::
cmake [<options>] {<path-to-source> | <path-to-existing-build>}
+ cmake [<options>] -S <path-to-source> -B <path-to-build>
cmake [{-D <var>=<value>}...] -P <cmake-script-file>
cmake --build <dir> [<options>...] [-- <build-tool-options>...]
cmake --open <dir>