summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-03-13 14:19:12 (GMT)
committerKitware Robot <kwrobot@kitware.com>2019-03-13 14:19:21 (GMT)
commit80b761b9244d5ab9047082be40ebeee256be95ef (patch)
treeb9e4f5ab3103102234a6edb0533d63bac8844823
parent7b81b1c72c5885ac5ec8097ff8f15677e55d8f94 (diff)
parentda2e58893524414a84cde576a472293c4641fe8a (diff)
downloadCMake-80b761b9244d5ab9047082be40ebeee256be95ef.zip
CMake-80b761b9244d5ab9047082be40ebeee256be95ef.tar.gz
CMake-80b761b9244d5ab9047082be40ebeee256be95ef.tar.bz2
Merge topic 'update-documentation'
da2e588935 cmake: Upgrade 'cmake -E' commands description Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !3089
-rw-r--r--Help/manual/cmake.1.rst16
-rw-r--r--Source/cmcmd.cxx4
2 files changed, 14 insertions, 6 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index e9a08b5..c5a3c88 100644
--- a/Help/manual/cmake.1.rst
+++ b/Help/manual/cmake.1.rst
@@ -390,16 +390,20 @@ Available commands are:
Copy files to ``<destination>`` (either file or directory).
If multiple files are specified, the ``<destination>`` must be
directory and it must exist. Wildcards are not supported.
+ ``copy`` does follow symlinks. That means it does not copy symlinks,
+ but the files or directories it point to.
``copy_directory <dir>... <destination>``
Copy directories to ``<destination>`` directory.
If ``<destination>`` directory does not exist it will be created.
+ ``copy_directory`` does follow symlinks.
``copy_if_different <file>... <destination>``
Copy files to ``<destination>`` (either file or directory) if
they have changed.
If multiple files are specified, the ``<destination>`` must be
directory and it must exist.
+ ``copy_if_different`` does follow symlinks.
``echo [<string>...]``
Displays arguments as text.
@@ -459,13 +463,16 @@ Available commands are:
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`` does not follow symlinks. That means it remove only symlinks
+ and not files it point to.
``remove_directory <dir>``
Remove a directory and its contents. If a directory does
not exist it will be silently ignored.
``rename <oldname> <newname>``
- Rename a file or directory (on one volume).
+ Rename a file or directory (on one volume). If file with the ``<newname>`` name
+ already exists, then it will be silently replaced.
``server``
Launch :manual:`cmake-server(7)` mode.
@@ -494,10 +501,11 @@ Available commands are:
``time <command> [<args>...]``
Run command and display elapsed time.
-``touch <file>``
- Touch a file.
+``touch <file>...``
+ Creates ``<file>`` if file do not exist.
+ If ``<file>`` exists, it is changing ``<file>`` access and modification times.
-``touch_nocreate <file>``
+``touch_nocreate <file>...``
Touch a file if it exists but do not create it. If a file does
not exist it will be silently ignored.
diff --git a/Source/cmcmd.cxx b/Source/cmcmd.cxx
index cefac7a..f996a3e 100644
--- a/Source/cmcmd.cxx
+++ b/Source/cmcmd.cxx
@@ -111,8 +111,8 @@ void CMakeCommandUsage(const char* program)
<< " tar [cxt][vf][zjJ] file.tar [file/dir1 file/dir2 ...]\n"
<< " - create or extract a tar or zip archive\n"
<< " time command [args...] - run command and display elapsed time\n"
- << " touch file - touch a file.\n"
- << " touch_nocreate file - touch a file but do not create it.\n"
+ << " touch <file>... - touch a <file>.\n"
+ << " touch_nocreate <file>... - touch a <file> but do not create it.\n"
<< " create_symlink old new - create a symbolic link new -> old\n"
#if defined(_WIN32) && !defined(__CYGWIN__)
<< "Available on Windows only:\n"