Add tip that --destination starting point is Drupal root (#5819)

* Add tip that `--destination` starting point is Drupal root It would be nice if the `drush archive:dump` starting point was from where the command was run ... which is normally here, for most projects using `drupal/recommended-project projects`: ``` $ tree -L 1 . ├── composer.json ├── composer.lock ├── vendor └── web ``` I guess it's not possible? So perhaps adding the tip that `--destination` starting point is Drupal root at the top would help people who run `drush archive:dump --destination=archive.tar.gz` don't see the file, and then after looking in web realize they need to run `drush archive:dump --destination=../archive.tar.gz`? * Update ArchiveDumpCommands.php * Move to `--destination` parameter * Update ArchiveDumpCommands.php * improve wording --------- Co-authored-by: Moshe Weitzman <[email protected]>
drush-ops · Nov 25, 2023 · 4f9b937 · 4f9b937
1 parent 30e77f2
commit 4f9b937
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/src/Commands/core/ArchiveDumpCommands.php b/src/Commands/core/ArchiveDumpCommands.php
@@ -64,7 +64,7 @@ final class ArchiveDumpCommands extends DrushCommands
      */
     #[CLI\Command(name: self::DUMP, aliases: ['ard'])]
     #[CLI\ValidatePhpExtensions(extensions: ['Phar'])]
-    #[CLI\Option(name: 'destination', description: 'The full path and filename in which the archive should be stored. If omitted, it will be saved to the drush-backups directory.')]
+    #[CLI\Option(name: 'destination', description: 'The full path and filename in which the archive should be stored. Any relative path will be calculated from Drupal root (usually <info>web</web> for drupal/recommended-project projects). If omitted, it will be saved to the configured temp directory.')]
     #[CLI\Option(name: 'overwrite', description: 'Overwrite destination file if exists.')]
     #[CLI\Option(name: 'code', description: 'Archive codebase.')]
     #[CLI\Option(name: 'exclude-code-paths', description: 'Comma-separated list of paths (or regular expressions matching paths) to exclude from the code archive.')]