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-13 16:04:21 +0100 |
| commit | 085bf7c97aae67e8f84fe95f97ee4bfee849d523 (patch) | |
| tree | 0d03b5ab49377d3f80e06bd04e815cf33cd7c9d1 /src | |
| parent | 96a76c79e40a5d6853c660fc2a980d084b0eaafd (diff) | |
| download | libguestfs-085bf7c97aae67e8f84fe95f97ee4bfee849d523.tar.gz libguestfs-085bf7c97aae67e8f84fe95f97ee4bfee849d523.tar.xz libguestfs-085bf7c97aae67e8f84fe95f97ee4bfee849d523.zip | |
docs: Make 'EVENTS' into its own =head1 section.
For some reason it was stuck under "CALLS WITH OPTIONAL ARGUMENTS",
which made no sense.
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 3c6d3eb1..151c7ad0 100644 --- a/src/guestfs.pod +++ b/src/guestfs.pod @@ -2047,6 +2047,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 @@ -2075,7 +2077,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 @@ -2232,6 +2234,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, @@ -2305,7 +2309,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 |