diff options
| author | Craig Scott <craig.scott@crascit.com> | 2017-04-09 07:01:30 +1000 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2017-04-10 09:50:10 -0400 |
| commit | 812274ff49135c80fb4562742d0889002119221d (patch) | |
| tree | 6d6ab70ad78eace1b7790d4dfaf991bc46adfcdf | |
| parent | 18eeed41948b265168497ea3360e7b0d56e8e8a9 (diff) | |
| download | cmake-812274ff49135c80fb4562742d0889002119221d.tar.gz | |
Help: Clarify what the -f option does for the remove command
Closes: #16784
| -rw-r--r-- | Help/manual/cmake.1.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 063aea16db..37e50d2fa6 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -263,8 +263,10 @@ Available commands are: 052f86c15bbde68af55c7f7b340ab639 file2.txt ``remove [-f] <file>...`` - Remove the file(s), use ``-f`` to force it. If a file does - not exist it will be silently ignored. + Remove the file(s). If any of the listed files already do not + exist, the command returns a non-zero exit code, but no message + is logged. The ``-f`` option changes the behavior to return a + zero exit code (i.e. success) in such situations instead. ``remove_directory <dir>`` Remove a directory and its contents. If a directory does |