diff options
author | Richard Jones <rjones@redhat.com> | 2009-11-24 14:00:34 +0000 |
---|---|---|
committer | Richard Jones <rjones@redhat.com> | 2009-11-24 16:01:11 +0000 |
commit | 3817708a5b182e8c170e653eb383961a34e30245 (patch) | |
tree | 9b78e398f63fb57f69809054d05e96f690b5928d /src | |
parent | b017cd67bb56284d05fc168d2b3536bee55b9ebf (diff) | |
download | libguestfs-3817708a5b182e8c170e653eb383961a34e30245.tar.gz libguestfs-3817708a5b182e8c170e653eb383961a34e30245.tar.xz libguestfs-3817708a5b182e8c170e653eb383961a34e30245.zip |
availability: Clarify and fix documentation.
Diffstat (limited to 'src')
-rwxr-xr-x | src/generator.ml | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/src/generator.ml b/src/generator.ml index 1206be22..722e2f7d 100755 --- a/src/generator.ml +++ b/src/generator.ml @@ -4109,24 +4109,24 @@ much more efficient to use C<guestfs_truncate_size>."); "test availability of some parts of the API", "\ This command is used to check the availability of some -groups of libguestfs functions which not all builds of -libguestfs will be able to provide. +groups of functionality in the appliance, which not all builds of +the libguestfs appliance will be able to provide. -The precise libguestfs function groups that may be checked by this -command are listed in L<guestfs(3)/AVAILABILITY>. +The libguestfs groups, and the functions that those +groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>. -The argument C<groups> is a list of API group names, eg: +The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas\"]> would check for the availability of -the C<guestfs_inotify_*> functions and C<guestfs_aug_*> -(partition editing) functions. +the Linux inotify functions and Augeas (configuration file +editing) functions. The command returns no error if I<all> requested groups are available. -It returns an error if one or more of the requested -groups is unavailable. +It fails with an error if one or more of the requested +groups is unavailable in the appliance. If an unknown group name is included in the -list of C<groups> then an error is always returned. +list of groups then an error is always returned. I<Notes:> @@ -4135,7 +4135,8 @@ I<Notes:> =item * You must call C<guestfs_launch> before calling this function. -The reason is because we don't know what function groups are + +The reason is because we don't know what groups are supported by the appliance/daemon until it is running and can be queried. |