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>
Wed, 3 Nov 2010 18:49:00 +0000 (18:49 +0000)
src/guestfs.pod

index da03128..dd06880 100644 (file)
@@ -877,8 +877,8 @@ 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.
+API functions can return errors.  For example, almost all functions
+that return C<int> will return C<-1> to indicate an error.
 
 Additional information is available for errors: an error message
 string and optionally an error number (errno) if the thing that failed