diff options
| author | Brad King <brad.king@kitware.com> | 2019-09-05 12:30:09 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2019-09-05 12:31:49 (GMT) |
| commit | 3beb2c440badc293c7cf783abe0f1f5e9fb6f497 (patch) | |
| tree | eed929aa7251283cf2ca30bded04b4ec34728554 | |
| parent | f545428be08531d2561feba4854793775be83c39 (diff) | |
| download | CMake-3beb2c440badc293c7cf783abe0f1f5e9fb6f497.zip CMake-3beb2c440badc293c7cf783abe0f1f5e9fb6f497.tar.gz CMake-3beb2c440badc293c7cf783abe0f1f5e9fb6f497.tar.bz2 | |
cmake: Document -E remove_directory symlink behavior
Update documentation for the change made by commit e6c9a8bac3 (cmake:
Teach -E remove_directory to remove directory symlinks, 2019-08-26).
Also add a release note.
Issue: #19533
| -rw-r--r-- | Help/manual/cmake.1.rst | 3 | ||||
| -rw-r--r-- | Help/release/dev/remove_directory-symlink.rst | 6 |
2 files changed, 8 insertions, 1 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 0645e41..2576cde 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -536,7 +536,8 @@ Available commands are: ``remove_directory <dir>...`` Remove ``<dir>`` directories and their contents. If a directory does - not exist it will be silently ignored. + not exist it will be silently ignored. If ``<dir>`` is a symlink to + a directory, just the symlink will be removed. ``rename <oldname> <newname>`` Rename a file or directory (on one volume). If file with the ``<newname>`` name diff --git a/Help/release/dev/remove_directory-symlink.rst b/Help/release/dev/remove_directory-symlink.rst new file mode 100644 index 0000000..0896388 --- /dev/null +++ b/Help/release/dev/remove_directory-symlink.rst @@ -0,0 +1,6 @@ +remove_directory-symlink +------------------------ + +* The :manual:`cmake(1)` ``-E remove_directory`` command-line tool, + when given the path to a symlink to a directory, now removes just + the symlink. It no longer removes content of the linked directory. |