docs: Clarify, not every function that returns int returns -1 for errors.
authorRichard W.M. Jones <rjones@redhat.com>
Wed, 3 Nov 2010 18:01:48 +0000 (18:01 +0000)
committerRichard W.M. Jones <rjones@redhat.com>
Fri, 5 Nov 2010 14:22:20 +0000 (14:22 +0000)
Cherry picked from commit aae5bebe6878c01803653fae166c58b7217b6100.

src/guestfs.pod

index 50e9f50..83dc683 100644 (file)
@@ -888,8 +888,9 @@ This closes the connection handle and frees up all resources used.
 
 =head1 ERROR HANDLING
 
-The convention in all functions that return C<int> is that they return
-C<-1> to indicate an error.  You can get additional information on
+API functions can return errors.  For example, almost all functions
+that return C<int> will return C<-1> to indicate an error.  You can
+get additional information on
 errors by calling L</guestfs_last_error> and/or by setting up an error
 handler with L</guestfs_set_error_handler>.