docs: Progress messages don't necessarily reach 100% in the error case.
authorRichard W.M. Jones <rjones@redhat.com>
Fri, 1 Apr 2011 12:54:18 +0000 (13:54 +0100)
committerRichard W.M. Jones <rjones@redhat.com>
Mon, 11 Apr 2011 10:05:43 +0000 (11:05 +0100)
This should be obvious, and now it is documented to avoid any
confusion.
(cherry picked from commit 05dbe09a5c5be3d5f68dc6eb033c4f642fbac8bf)

src/guestfs.pod

index d9838cf..3b43b65 100644 (file)
@@ -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