From 3be328ed709d7d893415ccc4ffc046835b74eb6b Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Thu, 12 Oct 2017 05:40:52 +0200 Subject: [PATCH 1/2] don't crash if only a global option is given, show help, fixes #3142 --- src/borg/archiver.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/borg/archiver.py b/src/borg/archiver.py index 1845d8840..0df5d94a0 100644 --- a/src/borg/archiver.py +++ b/src/borg/archiver.py @@ -1959,6 +1959,8 @@ class Archiver: parser.print_help() return EXIT_SUCCESS + do_maincommand_help = do_subcommand_help + def preprocess_args(self, args): deprecations = [ # ('--old', '--new' or None, 'Warning: "--old" has been deprecated. Use "--new" instead.'), @@ -2226,6 +2228,7 @@ class Archiver: parser = argparse.ArgumentParser(prog=self.prog, description='Borg - Deduplicated Backups', add_help=False) + parser.set_defaults(func=functools.partial(self.do_maincommand_help, parser)) parser.common_options = self.CommonOptions(define_common_options, suffix_precedence=('_maincommand', '_midcommand', '_subcommand')) parser.add_argument('-V', '--version', action='version', version='%(prog)s ' + __version__, From ed1a8b5cf1009423cb34753e9c1e0dda3b4b7b91 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Thu, 12 Oct 2017 06:03:12 +0200 Subject: [PATCH 2/2] add example showing --show-version --show-rc --- docs/usage/general.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/usage/general.rst b/docs/usage/general.rst index 127ab6676..5629aa5b8 100644 --- a/docs/usage/general.rst +++ b/docs/usage/general.rst @@ -30,3 +30,11 @@ Common options All Borg commands share these options: .. include:: common-options.rst.inc + +Examples +~~~~~~~~ +:: + + # Create an archive and log: borg version, files list, return code + $ borg create --show-version --list --show-rc /path/to/repo::my-files files +