From: Richard W.M. Jones <rjones@redhat.com>
Date: Wed, 3 Nov 2010 18:33:31 +0000 (+0000)
Subject: docs: Clarify no additional error available from guestfs_create.
X-Git-Tag: 1.6.1~10
X-Git-Url: http://git.annexia.org/?a=commitdiff_plain;h=33c77e9f445537deb46a3303450f7ab6847bd12a;p=libguestfs.git

docs: Clarify no additional error available from guestfs_create.
(cherry picked from commit 5d6a91844520d07f9477e2ddca4caf8f040ef8a1)
---

diff --git a/src/guestfs.pod b/src/guestfs.pod
index 7ac856c..569822a 100644
--- a/src/guestfs.pod
+++ b/src/guestfs.pod
@@ -924,6 +924,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);