summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2022-03-21 19:09:23 (GMT)
committerBrad King <brad.king@kitware.com>2022-03-22 13:27:47 (GMT)
commit9f1471739d83c9e61b6700a0c369b7f7bbb19071 (patch)
tree2fb485885eb07f35342bc17485d27946bc819f92 /Help
parent7e642a6fa0884cf683a1a50dd5cab93acd1e3950 (diff)
downloadCMake-9f1471739d83c9e61b6700a0c369b7f7bbb19071.zip
CMake-9f1471739d83c9e61b6700a0c369b7f7bbb19071.tar.gz
CMake-9f1471739d83c9e61b6700a0c369b7f7bbb19071.tar.bz2
cmake: Add --fresh option to clear the cache and start from scratch
Simplify the workflow to re-run CMake from scratch as if a build tree were never before processed, regardless of whether it has been. Fixes: #23119
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/cmake.1.rst7
-rw-r--r--Help/release/dev/cmake-fresh.rst5
2 files changed, 12 insertions, 0 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index e93cbe5..93d2ba4 100644
--- a/Help/manual/cmake.1.rst
+++ b/Help/manual/cmake.1.rst
@@ -197,6 +197,13 @@ Options
.. include:: OPTIONS_BUILD.txt
+``--fresh``
+ .. versionadded:: 3.24
+
+ Perform a fresh configuration of the build tree.
+ This removes any existing ``CMakeCache.txt`` file and associated
+ ``CMakeFiles/`` directory, and recreates them from scratch.
+
``-L[A][H]``
List non-advanced cached variables.
diff --git a/Help/release/dev/cmake-fresh.rst b/Help/release/dev/cmake-fresh.rst
new file mode 100644
index 0000000..6de5b4e
--- /dev/null
+++ b/Help/release/dev/cmake-fresh.rst
@@ -0,0 +1,5 @@
+cmake-fresh
+-----------
+
+* :manual:`cmake(1)` gained the ``--fresh`` command-line option to remove
+ any existing ``CMakeCache.txt`` when configuring a build tree.