arv-copy: Make the help text for the --src and --dst options more easily

intelligible.

No issue #

diff --git a/doc/sdk/cli/subcommands.html.textile.liquid b/doc/sdk/cli/subcommands.html.textile.liquid
index 3184c0929c2add50e6140a0f7d94696418ad32c2..018213c1a1815061f3265a85040937dcb53652a7 100644 (file)
--- a/doc/sdk/cli/subcommands.html.textile.liquid
+++ b/doc/sdk/cli/subcommands.html.textile.liquid
@@ -45,11 +45,11 @@ h3(#arv-copy). arv copy
 <notextile>
 <pre>
 $ <code class="userinput">arv copy --help</code>
-usage: arv-copy [-h] [-v] [--progress] [--no-progress] [-f] --src
-                SOURCE_ARVADOS --dst DESTINATION_ARVADOS [--recursive]
-                [--no-recursive] [--dst-git-repo DST_GIT_REPO]
-                [--project-uuid PROJECT_UUID] [--retries RETRIES]
-                object_uuid
+usage: arv_copy.py [-h] [-v] [--progress] [--no-progress] [-f] --src
+                   SOURCE_ARVADOS --dst DESTINATION_ARVADOS [--recursive]
+                   [--no-recursive] [--dst-git-repo DST_GIT_REPO]
+                   [--project-uuid PROJECT_UUID] [--retries RETRIES]
+                   object_uuid
 
 Copy a pipeline instance, template or collection from one Arvados instance to
 another.
@@ -64,15 +64,15 @@ optional arguments:
   --no-progress         Do not report progress on copying collections.
   -f, --force           Perform copy even if the object appears to exist at
                         the remote destination.
-  --src SOURCE_ARVADOS  The name of the source Arvados instance (required).
-                        May be either a pathname to a config file, or the
-                        basename of a file in
-                        $HOME/.config/arvados/instance_name.conf.
+  --src SOURCE_ARVADOS  The name of the source Arvados instance (required) -
+                        points at an Arvados config file. May be either a
+                        pathname to a config file, or (for example) "foo" as
+                        shorthand for $HOME/.config/arvados/foo.conf.
   --dst DESTINATION_ARVADOS
                         The name of the destination Arvados instance
-                        (required). May be either a pathname to a config file,
-                        or the basename of a file in
-                        $HOME/.config/arvados/instance_name.conf.
+                        (required) - points at an Arvados config file. May be
+                        either a pathname to a config file, or (for example)
+                        "foo" as shorthand for $HOME/.config/arvados/foo.conf.
   --recursive           Recursively copy any dependencies for this object.
                         (default)
   --no-recursive        Do not copy any dependencies. NOTE: if this option is

diff --git a/sdk/python/arvados/commands/arv_copy.py b/sdk/python/arvados/commands/arv_copy.py
index 8ee61f5bc123f260f566f373e878bef8ee8d5f26..a10eb2b348aff4499648d6738b8042e5a9d4fa11 100755 (executable)
--- a/sdk/python/arvados/commands/arv_copy.py
+++ b/sdk/python/arvados/commands/arv_copy.py
@@ -71,10 +71,10 @@ def main():
         help='Perform copy even if the object appears to exist at the remote destination.')
     copy_opts.add_argument(
         '--src', dest='source_arvados', required=True,
-        help='The name of the source Arvados instance (required). May be either a pathname to a config file, or the basename of a file in $HOME/.config/arvados/instance_name.conf.')
+        help='The name of the source Arvados instance (required) - points at an Arvados config file. May be either a pathname to a config file, or (for example) "foo" as shorthand for $HOME/.config/arvados/foo.conf.')
     copy_opts.add_argument(
         '--dst', dest='destination_arvados', required=True,
-        help='The name of the destination Arvados instance (required). May be either a pathname to a config file, or the basename of a file in $HOME/.config/arvados/instance_name.conf.')
+        help='The name of the destination Arvados instance (required) - points at an Arvados config file. May be either a pathname to a config file, or (for example) "foo" as shorthand for $HOME/.config/arvados/foo.conf.')
     copy_opts.add_argument(
         '--recursive', dest='recursive', action='store_true',
         help='Recursively copy any dependencies for this object. (default)')