diff options
| author | Brad King <brad.king@kitware.com> | 2017-04-10 14:00:55 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2017-04-10 14:00:58 (GMT) |
| commit | 54d8c0db00d0eeb27dc7abf9d67df74801c8d907 (patch) | |
| tree | e3c0299bcec0a78c8c86cb5114dc0d51ee18d650 /Help | |
| parent | 730a5480555ddf142e489ec4d4f3828824008a8f (diff) | |
| parent | 812274ff49135c80fb4562742d0889002119221d (diff) | |
| download | CMake-54d8c0db00d0eeb27dc7abf9d67df74801c8d907.zip CMake-54d8c0db00d0eeb27dc7abf9d67df74801c8d907.tar.gz CMake-54d8c0db00d0eeb27dc7abf9d67df74801c8d907.tar.bz2 | |
Merge topic 'clarifyRemoveDocs'
812274ff Help: Clarify what the -f option does for the remove command
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !680
Diffstat (limited to 'Help')
| -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 a11e2f9..b2e2828 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 |