Fix drush-ops#5183. sql:sync does not accept a directory as a target

weitzman · Sep 19, 2022 · f2ce7a6 · f2ce7a6
1 parent 3b87019
commit f2ce7a6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/docs/site-aliases.md b/docs/site-aliases.md
@@ -109,6 +109,10 @@ To convert legacy alias (*.aliases.drushrc.php) to yml, run the
 
 See [examples/Commands/SiteAliasAlterCommands.php](https://www.drush.org/latest/examples/SiteAliasAlterCommands.php/)) for an example.
 
+### Site specifications:
+
+When a site alias name is provided on the command line, a site specification may be used instead. A site specification is a site alias that is not saved on the filesystem but instead is directly e.g. `drush user@server/path/to/drupal#uri core:status`. See [example site specifications](https://github.com/consolidation/site-alias/blob/ef2eb7d37e59b3d837b4556d4d8070cb345b378c/src/SiteSpecParser.php#L24-L31).
+
 ### Environment variables
 
 Site aliases may reference environment variables, just like any Drush config

diff --git a/src/Commands/sql/SqlSyncCommands.php b/src/Commands/sql/SqlSyncCommands.php
@@ -20,8 +20,8 @@ class SqlSyncCommands extends DrushCommands implements SiteAliasManagerAwareInte
      *
      * @command sql:sync
      * @aliases sql-sync
-     * @param $source A site-alias or the name of a subdirectory within /sites whose database you want to copy from.
-     * @param $target A site-alias or the name of a subdirectory within /sites whose database you want to replace.
+     * @param $source A site-alias or site specification whose database you want to copy from.
+     * @param $target A site-alias or site specification whose database you want to replace.
      * @optionset_table_selection
      * @option no-dump Do not dump the sql database; always use an existing dump file.
      * @option no-sync Do not rsync the database dump file from source to target.