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 18:42:33 +0000 |
| commit | e19786c1a739bd683c1f31b2d60abe921e44319b (patch) | |
| tree | 3c75efed2f13a2b59e5f7d966dc9d51758df4356 /src | |
| parent | 7004a88d1db10f2e72d75ffe3c69a7528ee608e0 (diff) | |
| download | libguestfs-e19786c1a739bd683c1f31b2d60abe921e44319b.tar.gz libguestfs-e19786c1a739bd683c1f31b2d60abe921e44319b.tar.xz libguestfs-e19786c1a739bd683c1f31b2d60abe921e44319b.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)
(cherry picked from commit 27114fc0267872792bccba6d9fc22652cadd1ce0)
Diffstat (limited to 'src')
| -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 b4da599b..696cc792 100644 --- a/src/guestfs.pod +++ b/src/guestfs.pod @@ -1810,6 +1810,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 @@ -1838,7 +1840,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 @@ -1995,6 +1997,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, @@ -2068,7 +2072,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 |