git.annexia.org
/
libguestfs.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (from parent 1:
91b3574
)
guestfs(3): Refresh documentation for guestfs_create, guestfs_close.
author
Richard W.M. Jones
<rjones@redhat.com>
Sat, 30 Apr 2011 22:31:06 +0000
(18:31 -0400)
committer
Richard W.M. Jones
<rjones@redhat.com>
Sat, 30 Apr 2011 22:31:06 +0000
(18:31 -0400)
src/guestfs.pod
patch
|
blob
|
history
diff --git
a/src/guestfs.pod
b/src/guestfs.pod
index
4e216f1
..
c6e5a28
100644
(file)
--- a/
src/guestfs.pod
+++ b/
src/guestfs.pod
@@
-1293,15
+1293,16
@@
L</MULTIPLE HANDLES AND MULTIPLE THREADS> below.
Create a connection handle.
Create a connection handle.
-
You have to call L</guestfs_add_drive_opts> (or one of the equivalen
t
-
calls) on the handle at least once
.
+
On success this returns a non-NULL pointer to a handle. On error i
t
+
returns NULL
.
-This function returns a non-NULL pointer to a handle on success or
-NULL on error.
+You have to "configure" the handle after creating it. This includes
+calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on
+the handle at least once.
After configuring the handle, you have to call L</guestfs_launch>.
After configuring the handle, you have to call L</guestfs_launch>.
-You may also want to configure error handling for the handle. See
+You may also want to configure error handling for the handle. See
the
L</ERROR HANDLING> section below.
=head2 guestfs_close
L</ERROR HANDLING> section below.
=head2 guestfs_close
@@
-1310,6
+1311,12
@@
L</ERROR HANDLING> section below.
This closes the connection handle and frees up all resources used.
This closes the connection handle and frees up all resources used.
+If autosync was set on the handle and the handle was launched, then
+this implicitly calls various functions to unmount filesystems and
+sync the disk. See L</guestfs_set_autosync> for more details.
+
+If a close callback was set on the handle, then it is called.
+
=head1 ERROR HANDLING
API functions can return errors. For example, almost all functions
=head1 ERROR HANDLING
API functions can return errors. For example, almost all functions