summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBen Boeckel <ben.boeckel@kitware.com>2024-02-27 10:53:08 (GMT)
committerBen Boeckel <ben.boeckel@kitware.com>2024-02-27 10:53:08 (GMT)
commit189d28d77d11c6e4d7b5a6e2ee88ceea0da41e81 (patch)
tree63b5f7b325e82973b36c012a4d7500e2e0dd2778 /Help
parentdc45b20aca1323d8497ac08d202fe238727c7198 (diff)
downloadCMake-189d28d77d11c6e4d7b5a6e2ee88ceea0da41e81.zip
CMake-189d28d77d11c6e4d7b5a6e2ee88ceea0da41e81.tar.gz
CMake-189d28d77d11c6e4d7b5a6e2ee88ceea0da41e81.tar.bz2
Help/file: mention the working directory for `ARCHIVE_EXTRACT`
See: https://discourse.cmake.org/t/10135
Diffstat (limited to 'Help')
-rw-r--r--Help/command/file.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/Help/command/file.rst b/Help/command/file.rst
index 4acdc7e..f373e24 100644
--- a/Help/command/file.rst
+++ b/Help/command/file.rst
@@ -1254,6 +1254,13 @@ Archiving
``LIST_ONLY`` will list the files in the archive rather than extract them.
+ .. note::
+ The working directory for this subcommand is the ``DESTINATION`` directory
+ (provided or computed) except when ``LIST_ONLY`` is specified. Therefore,
+ outside of script mode, it may be best to provide absolute paths to
+ ``INPUT`` archives as they are unlikely to be extracted where a relative
+ path works.
+
.. versionadded:: 3.24
The ``TOUCH`` option gives extracted files a current local
timestamp instead of extracting file timestamps from the archive.