21504: Refine arv-mount description and epilog
authorBrett Smith <brett.smith@curii.com>
Sun, 25 Feb 2024 04:33:20 +0000 (23:33 -0500)
committerBrett Smith <brett.smith@curii.com>
Sun, 25 Feb 2024 21:40:32 +0000 (16:40 -0500)
* Modernize the description.
* Remove outdated mode information.
* Move epilog to --exec help.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

services/fuse/arvados_fuse/command.py

index 3c9d5f5822350de7e3eac0b396ce6ac70733edaf..cc00321cd078a577f93a4a3e3270712147f8d78b 100644 (file)
@@ -28,14 +28,8 @@ class ArgumentParser(argparse.ArgumentParser):
     def __init__(self):
         super(ArgumentParser, self).__init__(
             parents=[arv_cmd.retry_opt],
-            description="""
-Mount Keep data under the local filesystem.  Default mode is --home
-""",
-            epilog="""
-    Note: When using the --exec feature, you must either specify the
-    mountpoint before --exec, or mark the end of your --exec arguments
-    with "--".
-            """)
+            description="Interact with Arvados data through a local filesystem",
+        )
         self.add_argument(
             '--version',
             action='version',
@@ -204,7 +198,13 @@ and delete it when unmounting.
             '--exec',
             nargs=argparse.REMAINDER,
             dest="exec_args",
-            help="""Mount, run a command, then unmount and exit""",
+            help="""
+Mount data, run the specified command, then unmount and exit.
+--exec reads all remaining options as the command to run,
+so it must be the last option you specify.
+Either end your command arguments (and other options) with a `--` argument,
+or specify --exec after your mount point.
+""",
         )
         lifecycle.add_argument(
             '--foreground',