From: Richard W.M. Jones <rjones@redhat.com>
Date: Fri, 1 Apr 2011 12:54:18 +0000 (+0100)
Subject: docs: Progress messages don't necessarily reach 100% in the error case.
X-Git-Tag: 1.8.5~10
X-Git-Url: http://git.annexia.org/?a=commitdiff_plain;h=e3dddaaddc9e4192c6252dcdde4f545c38477c42;p=libguestfs.git

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.
(cherry picked from commit 05dbe09a5c5be3d5f68dc6eb033c4f642fbac8bf)
---

diff --git a/src/guestfs.pod b/src/guestfs.pod
index d9838cf..3b43b65 100644
--- a/src/guestfs.pod
+++ b/src/guestfs.pod
@@ -1711,7 +1711,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