From 1cb0f384fd3a2ca20ab9ce8421272a366efb801e Mon Sep 17 00:00:00 2001 From: Andrew David Wong Date: Fri, 15 Jul 2016 16:29:01 -0700 Subject: [PATCH] Revise help and stderr messages --- qvm-tools/qvm-backup-restore | 118 ++++++++++++++++++++++------------- 1 file changed, 75 insertions(+), 43 deletions(-) diff --git a/qvm-tools/qvm-backup-restore b/qvm-tools/qvm-backup-restore index 00ad7ba4..4a5cab47 100755 --- a/qvm-tools/qvm-backup-restore +++ b/qvm-tools/qvm-backup-restore @@ -43,27 +43,31 @@ def main(): parser.add_option ("--verify-only", action="store_true", dest="verify_only", default=False, - help="Do not restore the data, only verify backup " - "integrify.") + help="Verify backup integrity without restoring any " + "data") parser.add_option ("--skip-broken", action="store_true", dest="skip_broken", default=False, - help="Do not restore VMs that have missing templates or netvms") + help="Do not restore VMs that have missing TemplateVMs " + "or NetVMs") parser.add_option ("--ignore-missing", action="store_true", dest="ignore_missing", default=False, - help="Ignore missing templates or netvms, restore VMs anyway") + help="Restore VMs even if their associated TemplateVMs " + "and NetVMs are missing") parser.add_option ("--skip-conflicting", action="store_true", dest="skip_conflicting", default=False, - help="Do not restore VMs that are already present on the host") + help="Do not restore VMs that are already present on " + "the host") parser.add_option ("--rename-conflicting", action="store_true", dest="rename_conflicting", default=False, - help="Restore VMs that are already present on the host under different name") + help="Restore VMs that are already present on the host " + "under different names") parser.add_option ("--force-root", action="store_true", dest="force_root", default=False, - help="Force to run, even with root privileges") + help="Force to run with root privileges") parser.add_option ("--replace-template", action="append", dest="replace_template", default=[], - help="Restore VMs using another template, syntax: " + help="Restore VMs using another TemplateVM; syntax: " "old-template-name:new-template-name (may be " "repeated)") @@ -71,20 +75,21 @@ def main(): help="Skip restore of specified VM (may be repeated)") parser.add_option ("--skip-dom0-home", action="store_false", dest="dom0_home", default=True, - help="Do not restore dom0 user home dir") + help="Do not restore dom0 user home directory") parser.add_option ("--ignore-username-mismatch", action="store_true", dest="ignore_username_mismatch", default=False, - help="Ignore dom0 username mismatch while restoring homedir") + help="Ignore dom0 username mismatch when restoring home " + "directory") parser.add_option ("-d", "--dest-vm", action="store", dest="appvm", - help="The AppVM to send backups to") + help="Specify VM containing the backup to be restored") parser.add_option ("-e", "--encrypted", action="store_true", dest="decrypt", default=False, help="The backup is encrypted") parser.add_option ("-p", "--passphrase-file", action="store", dest="pass_file", default=None, - help="File containing the pass phrase to use, or '-' to read it from stdin") + help="Read passphrase from file, or use '-' to read from stdin") parser.add_option ("-z", "--compressed", action="store_true", dest="compressed", default=False, help="The backup is compressed") @@ -95,7 +100,8 @@ def main(): (options, args) = parser.parse_args () if (len (args) < 1): - print >> sys.stderr, "You must specify the backup directory (e.g. /mnt/backup/qubes-2010-12-01-235959)" + print >> sys.stderr, "You must specify the backup directory "\ + "(e.g. /mnt/backup/qubes-2010-12-01-235959)" exit (0) backup_dir = args[0] @@ -141,7 +147,8 @@ def main(): if f is not sys.stdin: f.close() else: - passphrase = getpass.getpass("Please enter the pass phrase to decrypt/verify the backup: ") + passphrase = getpass.getpass("Please enter the passphrase to verify " + "and (if encrypted) decrypt the backup: ") encoding = sys.stdin.encoding or getpreferredencoding() passphrase = passphrase.decode(encoding) @@ -197,67 +204,92 @@ def main(): print if hasattr(os, "geteuid") and os.geteuid() == 0: - print >> sys.stderr, "*** Running this tool as root is strongly discouraged, this will lead you in permissions problems." + print >> sys.stderr, "*** Running this tool as root is strongly "\ + "discouraged. This will lead to permissions "\ + "problems." if options.force_root: - print >> sys.stderr, "Continuing as commanded. You have been warned." + print >> sys.stderr, "Continuing as commanded. You have been "\ + "warned." else: - print >> sys.stderr, "Retry as unprivileged user." - print >> sys.stderr, "... or use --force-root to continue anyway." + print >> sys.stderr, "Retry as an unprivileged user, or use "\ + "--force-root to continue anyway." exit(1) if there_are_conflicting_vms: - print >> sys.stderr, "*** There VMs with conflicting names on the host! ***" + print >> sys.stderr, "*** There are VMs with conflicting names on the "\ + "host! ***" if options.skip_conflicting: - print >> sys.stderr, "Those VMs will not be restored, the host VMs will not be overwritten!" + print >> sys.stderr, "Those VMs will not be restored. The host "\ + "VMs will NOT be overwritten." else: - print >> sys.stderr, "Remove VMs with conflicting names from the host before proceeding." - print >> sys.stderr, "... or use --skip-conflicting to restore only those VMs that do not exist on the host." - print >> sys.stderr, "... or use --rename-conflicting to " \ - "restore those VMs under modified " \ - "name (with number at the end)" + print >> sys.stderr, "Remove VMs with conflicting names from the "\ + "host before proceeding." + print >> sys.stderr, "Or use --skip-conflicting to restore only "\ + "those VMs that do not exist on the host." + print >> sys.stderr, "Or use --rename-conflicting to restore " \ + "those VMs under modified names (with "\ + "numbers at the end)." exit (1) print "The above VMs will be copied and added to your system." - print "Exisiting VMs will not be removed." + print "Exisiting VMs will NOT be removed." if there_are_missing_templates: - print >> sys.stderr, "*** One or more template VM is missing on the host! ***" + print >> sys.stderr, "*** One or more TemplateVMs are missing on the"\ + "host! ***" if not (options.skip_broken or options.ignore_missing): - print >> sys.stderr, "Install it first, before proceeding with backup restore." - print >> sys.stderr, "Or pass: --skip-broken or --ignore-missing switch." + print >> sys.stderr, "Install them before proceeding with the "\ + "restore." + print >> sys.stderr, "Or pass: --skip-broken or --ignore-missing." exit (1) elif options.skip_broken: - print >> sys.stderr, "... VMs that depend on it will not be restored (--skip-broken used)" + print >> sys.stderr, "Skipping broken entries: VMs that depend on "\ + "missing TemplateVMs will NOT be restored." elif options.ignore_missing: - print >> sys.stderr, "... VMs that depend on it will be restored anyway (--ignore-missing used)" + print >> sys.stderr, "Ignoring missing entries: VMs that depend "\ + "on missing TemplateVMs will NOT be restored." else: - print >> sys.stderr, "INTERNAL ERROR?!" + print >> sys.stderr, "INTERNAL ERROR! Please report this to the "\ + "Qubes OS team!" exit (1) if there_are_missing_netvms: - print >> sys.stderr, "*** One or more network VM is missing on the host! ***" + print >> sys.stderr, "*** One or more NetVMs are missing on the "\ + "host! ***" if not (options.skip_broken or options.ignore_missing): - print >> sys.stderr, "Install it first, before proceeding with backup restore." - print >> sys.stderr, "Or pass: --skip_broken or --ignore_missing switch." + print >> sys.stderr, "Install them before proceeding with the "\ + "restore." + print >> sys.stderr, "Or pass: --skip-broken or --ignore-missing." exit (1) elif options.skip_broken: - print >> sys.stderr, "... VMs that depend on it will not be restored (--skip-broken used)" + print >> sys.stderr, "Skipping broken entries: VMs that depend on "\ + "missing NetVMs will NOT be restored." elif options.ignore_missing: - print >> sys.stderr, "... VMs that depend on it be restored anyway (--ignore-missing used)" + print >> sys.stderr, "Ignoring missing entries: VMs that depend "\ + "on missing NetVMs will NOT be restored." else: - print >> sys.stderr, "INTERNAL ERROR?!" + print >> sys.stderr, "INTERNAL ERROR! Please report this to the "\ + "Qubes OS team!" exit (1) if 'dom0' in restore_info.keys() and options.dom0_home: if dom0_username_mismatch: - print >> sys.stderr, "*** Dom0 username mismatch! This can break some settings ***" + print >> sys.stderr, "*** Dom0 username mismatch! This can break "\ + "some settings! ***" if not options.ignore_username_mismatch: - print >> sys.stderr, "Skip dom0 home restore (--skip-dom0-home)" - print >> sys.stderr, "Or pass: --ignore-username-mismatch to continue anyway" + print >> sys.stderr, "Skip restoring the dom0 home directory "\ + "(--skip-dom0-home), or pass "\ + "--ignore-username-mismatch to continue "\ + "anyway." exit(1) else: - print >> sys.stderr, "Continuing as directed" - print >> sys.stderr, "While restoring user homedir, existing files/dirs will be backed up in 'home-pre-restore-' dir" + print >> sys.stderr, "Continuing as directed." + print >> sys.stderr, "NOTE: Before restoring the dom0 home directory, " + "a new directory named "\ + "'home-pre-restore-' will be "\ + "created inside the dom0 home directory, and "\ + "all the other existing contents of the dom0 "\ + "home directory will be moved there." if options.pass_file is None: if raw_input("Do you want to proceed? [y/N] ").upper() != "Y":