duplicity-team team mailing list archive

[Aaron Whitehouse <lists@xxxxxxxxxxxxxxxxxx>]

Aaron Whitehouse has proposed merging lp:~aaron-whitehouse/duplicity/08-fix-man-verify into lp:duplicity.

Requested reviews:
  duplicity-team (duplicity-team)
Related bugs:
  Bug #1688659 in Duplicity: "Improve man page for verify and --compare-data"
  https://bugs.launchpad.net/duplicity/+bug/1688659

For more details, see:
https://code.launchpad.net/~aaron-whitehouse/duplicity/08-fix-man-verify/+merge/325044

Fix description of --verify and --compare-data in the man page. Now clarifies that verify compares the restored files to hashes stored at backup date, while --compare-data compares restored files to files in target_path.
-- 
Your team duplicity-team is requested to review the proposed merge of lp:~aaron-whitehouse/duplicity/08-fix-man-verify into lp:duplicity.

=== modified file 'bin/duplicity.1'
--- bin/duplicity.1	2017-05-12 21:55:05 +0000
+++ bin/duplicity.1	2017-06-04 16:35:10 +0000
@@ -168,17 +168,22 @@
 
 .TP
 .BI "verify " "[--compare-data] [--time <time>] [--file-to-restore <rel_path>] <url> <local_path>"
-Restore backup contents temporarily file by file and compare against the local path's contents.
-duplicity will exit with a non-zero error level if any files are different.
-On verbosity level info (4) or higher, a message for each file that has
-changed will be logged.
+Verify tests the integrity of the backup archives at the remote location by downloading each file
+and checking both that it can restore the archive and that the restored file matches the signature
+of that file stored in the backup, i.e. compares the archived file with its hash value from archival
+time. Verify does not actually restore and will not overwrite any local files. Duplicity
+will exit with a non-zero error level if any files do not match the signature stored in the archive
+for that file. On verbosity level 4 or higher, it will log a message for each file that differs
+from the stored signature. Files must be downloaded to the local machine in order to compare them.
+Verify does not compare the backed-up version of the file to the current local copy of the files
+unless the --compare-data option is used (see below).
 .br
 The
 .I --file-to-restore
 option restricts verify to that file or folder.
 The
 .I --time
-option allows to select a backup to verify against.
+option allows to select a backup to verify.
 The
 .I --compare-data
 option enables data comparison (see below).
@@ -344,8 +349,14 @@
 
 .TP
 .BI --compare-data
-Enable data comparison of regular files on action verify.
-This is disabled by default for performance reasons.
+Enable data comparison of regular files on action verify. This conducts a
+verify as described above to verify the integrity of the backup archives,
+but additionally compares restored files to those in target_directory.
+Duplicity will not replace any files in target_directory. Duplicity will
+exit with a non-zero error level if the files do not correctly verify or
+if any files from the archive differ from those in target_directory. On
+verbosity level 4 or higher, it will log a message for each file that
+differs from its equivalent in target_directory.
 
 .TP
 .BI --copy-links