From c0804ff5a201895d49db2799361cfe94bee40779 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Tue, 21 May 2019 01:31:21 +0200 Subject: [PATCH 1/2] argparser: always use REPOSITORY in metavar also: use more consistent help phrasing. --- src/borg/archiver.py | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/src/borg/archiver.py b/src/borg/archiver.py index 32571e273..5b6009fc3 100644 --- a/src/borg/archiver.py +++ b/src/borg/archiver.py @@ -2672,9 +2672,9 @@ class Archiver: help='benchmarks borg CRUD (create, extract, update, delete).') subparser.set_defaults(func=self.do_benchmark_crud) - subparser.add_argument('location', metavar='REPO', + subparser.add_argument('location', metavar='REPOSITORY', type=location_validator(archive=False), - help='repo to use for benchmark (must exist)') + help='repository to use for benchmark (must exist)') subparser.add_argument('path', metavar='PATH', help='path were to create benchmark input data') @@ -3138,7 +3138,7 @@ class Archiver: subparser.set_defaults(func=self.do_debug_dump_repo_objs) subparser.add_argument('location', metavar='REPOSITORY', type=location_validator(archive=False), - help='repo to dump') + help='repository to dump') subparser.add_argument('--ghost', dest='ghost', action='store_true', help='dump all segment file contents, including deleted/uncommitted objects and commits.') @@ -3153,7 +3153,7 @@ class Archiver: subparser.set_defaults(func=self.do_debug_search_repo_objs) subparser.add_argument('location', metavar='REPOSITORY', type=location_validator(archive=False), - help='repo to search') + help='repository to search') subparser.add_argument('wanted', metavar='WANTED', type=str, help='term to search the repo for, either 0x1234abcd hex term or a string') @@ -3277,9 +3277,9 @@ class Archiver: 'use ``--force --force`` in case ``--force`` does not work.') subparser.add_argument('--save-space', dest='save_space', action='store_true', help='work slower, but using less space') - subparser.add_argument('location', metavar='TARGET', nargs='?', default='', + subparser.add_argument('location', metavar='REPOSITORY_OR_ARCHIVE', nargs='?', default='', type=location_validator(), - help='archive or repository to delete') + help='repository or archive to delete') subparser.add_argument('archives', metavar='ARCHIVE', nargs='*', help='archives to delete') define_archive_filters_group(subparser) @@ -3461,7 +3461,7 @@ class Archiver: subparser.set_defaults(func=self.do_info) subparser.add_argument('location', metavar='REPOSITORY_OR_ARCHIVE', nargs='?', default='', type=location_validator(), - help='archive or repository to display information about') + help='repository or archive to display information about') subparser.add_argument('--json', action='store_true', help='format output as JSON') define_archive_filters_group(subparser) @@ -3750,7 +3750,7 @@ class Archiver: 'A "bpath" key is therefore not available.') subparser.add_argument('location', metavar='REPOSITORY_OR_ARCHIVE', nargs='?', default='', type=location_validator(), - help='repository/archive to list contents of') + help='repository or archive to list contents of') subparser.add_argument('paths', metavar='PATH', nargs='*', type=str, help='paths to list; patterns are supported') define_archive_filters_group(subparser) @@ -3810,7 +3810,7 @@ class Archiver: help='mount repository') subparser.set_defaults(func=self.do_mount) subparser.add_argument('location', metavar='REPOSITORY_OR_ARCHIVE', type=location_validator(), - help='repository/archive to mount') + help='repository or archive to mount') subparser.add_argument('mountpoint', metavar='MOUNTPOINT', type=str, help='where to mount filesystem') subparser.add_argument('-f', '--foreground', dest='foreground', @@ -4017,7 +4017,7 @@ class Archiver: subparser.add_argument('location', metavar='REPOSITORY_OR_ARCHIVE', nargs='?', default='', type=location_validator(), - help='repository/archive to recreate') + help='repository or archive to recreate') subparser.add_argument('paths', metavar='PATH', nargs='*', type=str, help='paths to recreate; patterns are supported') From 42de5b9a792c86f8d850e6f2a8e44073496f17b7 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Tue, 21 May 2019 02:00:47 +0200 Subject: [PATCH 2/2] location arg - should it be optional? fixes #4541. compact / config: yes, should be optional (can get repo from BORG_REPO environment variable) some debug commands: rather not, have non-optional addtl. posargs --- src/borg/archiver.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/borg/archiver.py b/src/borg/archiver.py index 5b6009fc3..a7ad42d2f 100644 --- a/src/borg/archiver.py +++ b/src/borg/archiver.py @@ -2806,7 +2806,7 @@ class Archiver: formatter_class=argparse.RawDescriptionHelpFormatter, help='compact segment files / free space in repo') subparser.set_defaults(func=self.do_compact) - subparser.add_argument('location', metavar='REPOSITORY', + subparser.add_argument('location', metavar='REPOSITORY', nargs='?', default='', type=location_validator(archive=False), help='repository to compact') subparser.add_argument('--cleanup-commits', dest='cleanup_commits', action='store_true', @@ -2843,7 +2843,7 @@ class Archiver: group.add_argument('-l', '--list', dest='list', action='store_true', help='list the configuration of the repo') - subparser.add_argument('location', metavar='REPOSITORY', + subparser.add_argument('location', metavar='REPOSITORY', nargs='?', default='', type=location_validator(archive=False, proto='file'), help='repository to configure') subparser.add_argument('name', metavar='NAME', nargs='?', @@ -3166,7 +3166,7 @@ class Archiver: formatter_class=argparse.RawDescriptionHelpFormatter, help='get object from repository (debug)') subparser.set_defaults(func=self.do_debug_get_obj) - subparser.add_argument('location', metavar='REPOSITORY', nargs='?', default='', + subparser.add_argument('location', metavar='REPOSITORY', type=location_validator(archive=False), help='repository to use') subparser.add_argument('id', metavar='ID', type=str, @@ -3183,7 +3183,7 @@ class Archiver: formatter_class=argparse.RawDescriptionHelpFormatter, help='put object to repository (debug)') subparser.set_defaults(func=self.do_debug_put_obj) - subparser.add_argument('location', metavar='REPOSITORY', nargs='?', default='', + subparser.add_argument('location', metavar='REPOSITORY', type=location_validator(archive=False), help='repository to use') subparser.add_argument('paths', metavar='PATH', nargs='+', type=str, @@ -3198,7 +3198,7 @@ class Archiver: formatter_class=argparse.RawDescriptionHelpFormatter, help='delete object from repository (debug)') subparser.set_defaults(func=self.do_debug_delete_obj) - subparser.add_argument('location', metavar='REPOSITORY', nargs='?', default='', + subparser.add_argument('location', metavar='REPOSITORY', type=location_validator(archive=False), help='repository to use') subparser.add_argument('ids', metavar='IDs', nargs='+', type=str, @@ -3213,7 +3213,7 @@ class Archiver: formatter_class=argparse.RawDescriptionHelpFormatter, help='show refcount for object from repository (debug)') subparser.set_defaults(func=self.do_debug_refcount_obj) - subparser.add_argument('location', metavar='REPOSITORY', nargs='?', default='', + subparser.add_argument('location', metavar='REPOSITORY', type=location_validator(archive=False), help='repository to use') subparser.add_argument('ids', metavar='IDs', nargs='+', type=str,