summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2024-02-27 14:11:36 (GMT)
committerKitware Robot <kwrobot@kitware.com>2024-02-27 14:11:42 (GMT)
commit5ac83689222d3158f1a6e32259096b80ebe89166 (patch)
tree67cafa4325c6cbc1b3c7e1f654cc3763cc71b6e0 /Help
parentfe82cd69000461a3bf1fe00b2662539c49cd9765 (diff)
parent189d28d77d11c6e4d7b5a6e2ee88ceea0da41e81 (diff)
downloadCMake-5ac83689222d3158f1a6e32259096b80ebe89166.zip
CMake-5ac83689222d3158f1a6e32259096b80ebe89166.tar.gz
CMake-5ac83689222d3158f1a6e32259096b80ebe89166.tar.bz2
Merge topic 'Help-file-ARCHIVE_EXTRACT-mention-working-dir' into release-3.29
189d28d77d Help/file: mention the working directory for `ARCHIVE_EXTRACT` Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !9291
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.