summaryrefslogtreecommitdiff
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-01-28 13:36:51 +0000
committerKitware Robot <kwrobot@kitware.com>2019-01-28 08:36:58 -0500
commit8e495333c0914a0684d6d82e2cc15327c9f811f3 (patch)
treec5c5aec66a12a56821377f63e65accd131c88c0f /Help
parentf677a3d7defdb82d79bca2faf09da6d9338773b3 (diff)
parentad0853b3d41bc8e0eae4f0baafab457ad52a9a7b (diff)
downloadcmake-8e495333c0914a0684d6d82e2cc15327c9f811f3.tar.gz
Merge topic 'cmake-gui-s-b'
ad0853b3d4 QtDialog: Clean up and document -S and -B options Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Robert Maynard <robert.maynard@kitware.com> Merge-request: !2863
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/cmake-gui.1.rst9
-rw-r--r--Help/release/dev/cmake-gui-s-b.rst5
2 files changed, 14 insertions, 0 deletions
diff --git a/Help/manual/cmake-gui.1.rst b/Help/manual/cmake-gui.1.rst
index 9322e33cbb..856aa2fba2 100644
--- a/Help/manual/cmake-gui.1.rst
+++ b/Help/manual/cmake-gui.1.rst
@@ -10,6 +10,7 @@ Synopsis
cmake-gui [<options>]
cmake-gui [<options>] {<path-to-source> | <path-to-existing-build>}
+ cmake-gui [<options>] -S <path-to-source> -B <path-to-build>
Description
===========
@@ -27,6 +28,14 @@ native tool on their platform.
Options
=======
+``-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.
+
.. include:: OPTIONS_HELP.txt
See Also
diff --git a/Help/release/dev/cmake-gui-s-b.rst b/Help/release/dev/cmake-gui-s-b.rst
new file mode 100644
index 0000000000..9447eb39a6
--- /dev/null
+++ b/Help/release/dev/cmake-gui-s-b.rst
@@ -0,0 +1,5 @@
+cmake-gui-s-b
+-------------
+
+* The :manual:`cmake-gui(1)` dialog gained new ``-S`` and ``-B`` arguments to
+ explicitly specify source and build directories.