From 3817708a5b182e8c170e653eb383961a34e30245 Mon Sep 17 00:00:00 2001 From: Richard Jones Date: Tue, 24 Nov 2009 14:00:34 +0000 Subject: [PATCH] availability: Clarify and fix documentation. --- src/generator.ml | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/src/generator.ml b/src/generator.ml index 1206be2..722e2f7 100755 --- a/src/generator.ml +++ b/src/generator.ml @@ -4109,24 +4109,24 @@ much more efficient to use C."); "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. +The libguestfs groups, and the functions that those +groups correspond to, are listed in L. -The argument C is a list of API group names, eg: +The argument C is a list of group names, eg: C<[\"inotify\", \"augeas\"]> would check for the availability of -the C functions and C -(partition editing) functions. +the Linux inotify functions and Augeas (configuration file +editing) functions. The command returns no error if I 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 then an error is always returned. +list of groups then an error is always returned. I @@ -4135,7 +4135,8 @@ I =item * You must call C 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. -- 1.8.3.1