New API: part-to-dev: Convert partition name to device name.

[libguestfs.git] / src / guestfs.pod

diff --git a/src/guestfs.pod b/src/guestfs.pod
index 43b7460..de5e254 100644 (file)
--- a/src/guestfs.pod
+++ b/src/guestfs.pod
@@ -1526,6 +1526,20 @@ When the daemon launches it sends an initial word
 (C<GUESTFS_LAUNCH_FLAG>) which indicates that the guest and daemon is
 alive.  This is what L</guestfs_launch> waits for.
 
 (C<GUESTFS_LAUNCH_FLAG>) which indicates that the guest and daemon is
 alive.  This is what L</guestfs_launch> waits for.
 

+=head3 PROGRESS NOTIFICATION MESSAGES
+
+The daemon may send progress notification messages at any time.  These
+are distinguished by the normal length word being replaced by
+C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message.
+
+The library turns them into progress callbacks (see
+C<guestfs_set_progress_callback>) if there is a callback registered,
+or discards them if not.
+
+The daemon self-limits the frequency of progress messages it sends
+(see C<daemon/proto.c:notify_progress>).  Not all calls generate
+progress messages.
+

 =head1 MULTIPLE HANDLES AND MULTIPLE THREADS
 
 All high-level libguestfs actions are synchronous.  If you want
 =head1 MULTIPLE HANDLES AND MULTIPLE THREADS
 
 All high-level libguestfs actions are synchronous.  If you want


@@ -1535,6 +1549,9 @@ Only use the handle from a single thread.  Either use the handle
 exclusively from one thread, or provide your own mutex so that two
 threads cannot issue calls on the same handle at the same time.
 
 exclusively from one thread, or provide your own mutex so that two
 threads cannot issue calls on the same handle at the same time.
 

+See the graphical program guestfs-browser for one possible
+architecture for multithreaded programs using libvirt and libguestfs.
+

 =head1 QEMU WRAPPERS
 
 If you want to compile your own qemu, run qemu from a non-standard
 =head1 QEMU WRAPPERS
 
 If you want to compile your own qemu, run qemu from a non-standard