summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard W.M. Jones <rjones@redhat.com>2011-04-01 13:54:18 +0100
committerRichard W.M. Jones <rjones@redhat.com>2011-04-01 16:05:30 +0100
commit05dbe09a5c5be3d5f68dc6eb033c4f642fbac8bf (patch)
tree574573bafe186b4d6f6d5fe9467bce1abca60154
parent94945d84c71703adc210793897e1a269a38945f2 (diff)
downloadlibguestfs-05dbe09a5c5be3d5f68dc6eb033c4f642fbac8bf.tar.gz
libguestfs-05dbe09a5c5be3d5f68dc6eb033c4f642fbac8bf.tar.xz
libguestfs-05dbe09a5c5be3d5f68dc6eb033c4f642fbac8bf.zip
docs: Progress messages don't necessarily reach 100% in the error case.
This should be obvious, and now it is documented to avoid any confusion.
-rw-r--r--src/guestfs.pod3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/guestfs.pod b/src/guestfs.pod
index b4607db8..91c6b330 100644
--- a/src/guestfs.pod
+++ b/src/guestfs.pod
@@ -1779,7 +1779,8 @@ indicator which shows the ratio of C<position>:C<total>.
=item *
If any progress notification is sent during a call, then a final
-progress notification is always sent when C<position> = C<total>.
+progress notification is always sent when C<position> = C<total>
+(I<unless> the call fails with an error).
This is to simplify caller code, so callers can easily set the
progress indicator to "100%" at the end of the operation, without