diff options
| author | Richard W.M. Jones <rjones@redhat.com> | 2012-10-13 09:29:38 +0100 |
|---|---|---|
| committer | Richard W.M. Jones <rjones@redhat.com> | 2012-10-30 17:14:24 +0000 |
| commit | 27114fc0267872792bccba6d9fc22652cadd1ce0 (patch) | |
| tree | 6ccb20f2ad6689843c304417ba336798daa83739 | |
| parent | 53eb3eb45afbf6685f92e10db954aa2b82618962 (diff) | |
| download | libguestfs-27114fc0267872792bccba6d9fc22652cadd1ce0.tar.gz libguestfs-27114fc0267872792bccba6d9fc22652cadd1ce0.tar.xz libguestfs-27114fc0267872792bccba6d9fc22652cadd1ce0.zip | |
docs: Make 'EVENTS' into its own =head1 section.
For some reason it was stuck under "CALLS WITH OPTIONAL ARGUMENTS",
which made no sense.
(cherry picked from commit 085bf7c97aae67e8f84fe95f97ee4bfee849d523)
| -rw-r--r-- | src/guestfs.pod | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/src/guestfs.pod b/src/guestfs.pod index 2c69c16c..ba537307 100644 --- a/src/guestfs.pod +++ b/src/guestfs.pod @@ -1890,6 +1890,8 @@ language-specific documentation for more details on that. For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>. +=head1 EVENTS + =head2 SETTING CALLBACKS TO HANDLE EVENTS B<Note:> This section documents the generic event mechanism introduced @@ -1918,7 +1920,7 @@ Events may contain a payload, usually nothing (void), an array of 64 bit unsigned integers, or a message buffer. Payloads are discussed later on. -=head3 CLASSES OF EVENTS +=head2 CLASSES OF EVENTS =over 4 @@ -2075,6 +2077,8 @@ If no callback is registered: the event is ignored. =back +=head2 EVENT API + =head3 guestfs_set_event_callback int guestfs_set_event_callback (guestfs_h *g, @@ -2148,7 +2152,7 @@ contain arbitrary 8 bit data, including NUL bytes. C<array> and C<array_len> is an array of 64 bit unsigned integers. At the moment this is only used for progress messages. -=head3 EXAMPLE: CAPTURING LOG MESSAGES +=head2 EXAMPLE: CAPTURING LOG MESSAGES One motivation for the generic event API was to allow GUI programs to capture debug and other messages. In libguestfs E<le> 1.8 these were |