Browse Source

Help: Update file(ARCHIVE...) synopsis for renamed options

The FILES and DIRECTORY options were renamed in bbcff21f71
(file(ARCHIVE*): Collapse FILES and DIRECTORY options, 2020-06-30), 
but the synopsis part of the file() documentation was missed.
The synopsis also typically only shows the mandatory options.
Update the synopsis to reflect the name changes and omit the
DESTINATION option since it is not mandatory.
Craig Scott 5 years ago
parent
commit
f9766dad19
1 changed files with 2 additions and 2 deletions
  1. 2 2
      Help/command/file.rst

+ 2 - 2
Help/command/file.rst

@@ -43,8 +43,8 @@ Synopsis
     file(`LOCK`_ <path> [...])
 
   `Archiving`_
-    file(`ARCHIVE_CREATE`_ OUTPUT <archive> FILES <files> [...])
-    file(`ARCHIVE_EXTRACT`_ INPUT <archive> DESTINATION <dir> [...])
+    file(`ARCHIVE_CREATE`_ OUTPUT <archive> PATHS <paths>... [...])
+    file(`ARCHIVE_EXTRACT`_ INPUT <archive> [...])
 
 Reading
 ^^^^^^^