summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2018-09-19 14:38:11 (GMT)
committerKitware Robot <kwrobot@kitware.com>2018-09-19 14:38:19 (GMT)
commitec9ef691feab1ae8fc4209330af91169b4faa076 (patch)
tree874d27896aa0aee1fa34170352f4847b29262561 /Help
parentc0cedaa6435d2eb1a49afab1eaa08ba3cd40290e (diff)
parent638f00117a8166702950a6c730fdfa453f788659 (diff)
downloadCMake-ec9ef691feab1ae8fc4209330af91169b4faa076.zip
CMake-ec9ef691feab1ae8fc4209330af91169b4faa076.tar.gz
CMake-ec9ef691feab1ae8fc4209330af91169b4faa076.tar.bz2
Merge topic 'provide_explicit_source_and_build_command_line_options'
638f00117a Add release note for the -S and -B options. de962cc00d CMake: Internally uses -S instead of -H to specify source directory a10d63d578 cmake: -S and -B can be used to specify source and build directories Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2358
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/OPTIONS_BUILD.txt8
-rw-r--r--Help/manual/cmake.1.rst1
-rw-r--r--Help/release/dev/cmake-explicit-dirs.rst10
3 files changed, 19 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>
diff --git a/Help/release/dev/cmake-explicit-dirs.rst b/Help/release/dev/cmake-explicit-dirs.rst
new file mode 100644
index 0000000..35f2d3a
--- /dev/null
+++ b/Help/release/dev/cmake-explicit-dirs.rst
@@ -0,0 +1,10 @@
+cmake-explicit-dirs
+-------------------
+
+* The :manual:`cmake <cmake(1)>` command gained the ``-S <source_dir>``
+ command line option to specify the location of the source directory.
+ This option can be used independently of ``-B``.
+
+* The :manual:`cmake <cmake(1)>` command gained the ``-B <build_dir>``
+ command line option to specify the location of the build directory.
+ This option can be used independently of ``-S``.