summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard W.M. Jones <rjones@redhat.com>2010-11-03 18:33:31 +0000
committerRichard W.M. Jones <rjones@redhat.com>2010-11-03 18:52:45 +0000
commit5d6a91844520d07f9477e2ddca4caf8f040ef8a1 (patch)
tree5e6c4bf22df538d74714150b001b45eb60733be0
parent01d613ae957431d65c700a34e369ef4c06dd6d8f (diff)
downloadlibguestfs-5d6a91844520d07f9477e2ddca4caf8f040ef8a1.tar.gz
libguestfs-5d6a91844520d07f9477e2ddca4caf8f040ef8a1.tar.xz
libguestfs-5d6a91844520d07f9477e2ddca4caf8f040ef8a1.zip
docs: Clarify no additional error available from guestfs_create.
-rw-r--r--src/guestfs.pod6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/guestfs.pod b/src/guestfs.pod
index b21a25dd..9717543e 100644
--- a/src/guestfs.pod
+++ b/src/guestfs.pod
@@ -920,6 +920,12 @@ Out of memory errors are handled differently. The default action is
to call L<abort(3)>. If this is undesirable, then you can set a
handler using L</guestfs_set_out_of_memory_handler>.
+L</guestfs_create> returns C<NULL> if the handle cannot be created,
+and because there is no handle if this happens there is no way to get
+additional error information. However L</guestfs_create> is supposed
+to be a lightweight operation which can only fail because of
+insufficient memory (it returns NULL in this case).
+
=head2 guestfs_last_error
const char *guestfs_last_error (guestfs_h *g);