Update gnt-backup manual to reflect real behavior
authorHrvoje Ribicic <riba@google.com>
Thu, 12 Feb 2015 19:11:32 +0000 (19:11 +0000)
committerHrvoje Ribicic <riba@google.com>
Wed, 18 Feb 2015 18:20:33 +0000 (19:20 +0100)
As the gnt-backup manual page still states incorrect information about
error codes stemming from 2010 and not reflecting changes of commit
44247302, this patch updates it.

Signed-off-by: Hrvoje Ribicic <riba@google.com>
Reviewed-by: Helga Velroyen <helgav@google.com>

man/gnt-backup.rst

index 409b955..ebf636f 100644 (file)
@@ -47,13 +47,12 @@ The ``--remove`` option can be used to remove the instance after it
 was exported. This is useful to make one last backup before
 removing the instance.
 
-The exit code of the command is 0 if all disks were backed up
-successfully, 1 if no data was backed up or if the configuration
-export failed, and 2 if just some of the disks failed to backup.
-The exact details of the failures will be shown during the command
-execution (and will be stored in the job log). It is recommended
-that for any non-zero exit code, the backup is considered invalid,
-and retried.
+Should the snapshotting or transfer of any of the instance disks
+fail, the backup will not complete and any previous backups will be
+preserved. The exact details of the failures will be shown during the
+command execution (and will be stored in the job log). It is
+recommended that for any non-zero exit code, the backup is considered
+invalid, and retried.
 
 See **ganeti**\(7) for a description of ``--submit`` and other common
 options.