summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHolger Weiß <holger@zedat.fu-berlin.de>2011-09-09 18:57:20 +0200
committerHolger Weiß <holger@zedat.fu-berlin.de>2011-09-09 18:57:20 +0200
commitee2c53f129ac14e4221157b738147c416247a383 (patch)
tree1e46863f0dc51c1425384704d69d0ae0aa60b0d1
parent2d5eff7ce9369b1ba5406833c1040d5c0daa05d4 (diff)
downloadbcfg2-ee2c53f129ac14e4221157b738147c416247a383.tar.gz
bcfg2-ee2c53f129ac14e4221157b738147c416247a383.tar.bz2
bcfg2-ee2c53f129ac14e4221157b738147c416247a383.zip
doc: Improve MetadataQuery documentation
Clarify that the names_by_groups() and names_by_profiles() query routines both expect a list as their argument.
-rw-r--r--doc/server/plugins/grouping/metadata.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/server/plugins/grouping/metadata.txt b/doc/server/plugins/grouping/metadata.txt
index 43cc6a2d7..fc8605115 100644
--- a/doc/server/plugins/grouping/metadata.txt
+++ b/doc/server/plugins/grouping/metadata.txt
@@ -281,9 +281,9 @@ This class provides query routines for the servers Metadata.
+==============================+================================================+===================+
| by_name(client) | Get ClientMetadata object for 'client' | ClientMetadata |
+------------------------------+------------------------------------------------+-------------------+
-| names_by_groups(group) | | |
+| names_by_groups(groups) | All client names in the list of 'groups' | List |
+------------------------------+------------------------------------------------+-------------------+
-| names_by_profiles(profile) | All clients names in 'profile' | List |
+| names_by_profiles(profiles) | All client names in the list of 'profiles' | List |
+------------------------------+------------------------------------------------+-------------------+
| all_clients() | All known client hostnames | List |
+------------------------------+------------------------------------------------+-------------------+