summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristian Fetzer <fetzer.ch@gmail.com>2016-11-01 09:23:15 (GMT)
committerChristian Fetzer <fetzer.ch@gmail.com>2016-11-01 09:25:18 (GMT)
commit311d0376e2312d3539bd997160f880cf58743834 (patch)
tree418708a6b355463d7037ecfd79fa95674bcb7255
parent77e78af1a2f10d5ec349d0a46118cddd8ec7a539 (diff)
downloadCMake-311d0376e2312d3539bd997160f880cf58743834.zip
CMake-311d0376e2312d3539bd997160f880cf58743834.tar.gz
CMake-311d0376e2312d3539bd997160f880cf58743834.tar.bz2
Help: Document error behavior of file(REMOVE/REMOVE_RECURSE)
Clarifies that there is no need to surround file(REMOVE/REMOVE_RECURSE) calls by `if(EXISTS)` as non existent files are silently ignored.
-rw-r--r--Help/command/file.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/Help/command/file.rst b/Help/command/file.rst
index 77e9f62..8da46cb 100644
--- a/Help/command/file.rst
+++ b/Help/command/file.rst
@@ -153,7 +153,8 @@ Move a file or directory within a filesystem from ``<oldname>`` to
file(REMOVE_RECURSE [<files>...])
Remove the given files. The ``REMOVE_RECURSE`` mode will remove the given
-files and directories, also non-empty directories
+files and directories, also non-empty directories. No error is emitted if a
+given file does not exist.
------------------------------------------------------------------------------