diff options
| author | Richard W.M. Jones <rjones@redhat.com> | 2010-11-03 18:01:48 +0000 |
|---|---|---|
| committer | Richard W.M. Jones <rjones@redhat.com> | 2010-11-03 18:49:00 +0000 |
| commit | aae5bebe6878c01803653fae166c58b7217b6100 (patch) | |
| tree | 200e73b4ba021c1b6d331a85a33f42e5dccc41fd /src/guestfs.pod | |
| parent | 9cd1810b5e5b0a09f1a6eaf64fa14b924fbb0eae (diff) | |
| download | libguestfs-aae5bebe6878c01803653fae166c58b7217b6100.tar.gz libguestfs-aae5bebe6878c01803653fae166c58b7217b6100.tar.xz libguestfs-aae5bebe6878c01803653fae166c58b7217b6100.zip | |
docs: Clarify, not every function that returns int returns -1 for errors.
Diffstat (limited to 'src/guestfs.pod')
| -rw-r--r-- | src/guestfs.pod | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/guestfs.pod b/src/guestfs.pod index da031286..dd068808 100644 --- a/src/guestfs.pod +++ b/src/guestfs.pod @@ -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 |