summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/appendix/guides/ubuntu.txt2
-rw-r--r--doc/conf.py2
-rw-r--r--doc/installation/source.txt3
-rw-r--r--doc/server/plugins/grouping/metadata.txt29
4 files changed, 26 insertions, 10 deletions
diff --git a/doc/appendix/guides/ubuntu.txt b/doc/appendix/guides/ubuntu.txt
index d85c34b02..f72247220 100644
--- a/doc/appendix/guides/ubuntu.txt
+++ b/doc/appendix/guides/ubuntu.txt
@@ -154,7 +154,7 @@ Create Packages layout (as per :ref:`packages-exampleusage`) in
[global]
root@lucid:~# cat /var/lib/bcfg2/Packages/sources.xml
<Sources>
- <Group name="lucid">
+ <Group name="ubuntu-lucid">
<Source type="apt" url="http://archive.ubuntu.com/ubuntu" version="lucid">
<Component>main</Component>
<Component>multiverse</Component>
diff --git a/doc/conf.py b/doc/conf.py
index 7e9c8b59c..38160715d 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -55,7 +55,7 @@ else:
# The short X.Y version.
version = '1.2'
# The full version, including alpha/beta/rc tags.
-release = '1.2.1'
+release = '1.2.2'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
diff --git a/doc/installation/source.txt b/doc/installation/source.txt
index 3ea0404ad..1406a5ceb 100644
--- a/doc/installation/source.txt
+++ b/doc/installation/source.txt
@@ -2,6 +2,7 @@
.. _GPG1: http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x75BF2C177F7D197E
.. _GPG2: http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x80B8492FA88FFF4B
+.. _Download: http://trac.mcs.anl.gov/projects/bcfg2/wiki/Download
.. _source:
@@ -14,7 +15,7 @@ Download
Tarball
^^^^^^^
-The Bcfg2 source tarball can be grabbed from the Download_ page.
+The Bcfg2 source tarball can be grabbed from the `Download`_ page.
All tarballs are signed with GPG keys `7F7D197E <GPG1>`_ or `A88FFF4B
<GPG2>`_. You can verify your download by importing the keys and running ::
diff --git a/doc/server/plugins/grouping/metadata.txt b/doc/server/plugins/grouping/metadata.txt
index c52ac7612..305857578 100644
--- a/doc/server/plugins/grouping/metadata.txt
+++ b/doc/server/plugins/grouping/metadata.txt
@@ -276,22 +276,37 @@ A special client metadata class is available to the
MetadataQuery
-------------
-This class provides query routines for the servers Metadata.
+This class provides query methods for the metadata of all clients
+known to the Bcfg2 server. Note that ``*by_groups()`` and
+``*by_profiles()`` behave differently; for a client to be included in
+the return value of a ``by_groups()`` method, it must be a member of
+*all* groups listed in the argument; for a client to be included in
+the return value of a ``by_profiles()`` method, it must have any group
+listed as its profile group.
+------------------------------+------------------------------------------------+-------------------+
| Method | Description | Value |
+==============================+================================================+===================+
| by_name(client) | Get ClientMetadata object for 'client' | ClientMetadata |
+------------------------------+------------------------------------------------+-------------------+
-| names_by_groups(groups) | All client names in the list of 'groups' | List |
+| by_groups(groups) | Get ClientMetadata object for clients in all | List of |
+| | listed groups | ClientMetadata |
+------------------------------+------------------------------------------------+-------------------+
-| names_by_profiles(profiles) | All client names in the list of 'profiles' | List |
+| by_profiles(client) | Get ClientMetadata objects for clients whose | List of |
+| | profile matches any listed profile group | ClientMetadata |
+------------------------------+------------------------------------------------+-------------------+
-| all_clients() | All known client hostnames | List |
+| names_by_groups(groups) | Get the names of all clients in all listed | List of strings |
+| | groups | |
+------------------------------+------------------------------------------------+-------------------+
-| all_groups() | All known group names | List |
+| names_by_profiles(profiles) | Get the names of clients whose profile matches | List of strings |
+| | any listed profile group | |
+------------------------------+------------------------------------------------+-------------------+
-| all_groups_in_category(cat) | All groups in category 'cat' | List |
+| all_clients() | All known client hostnames | List of strings |
+------------------------------+------------------------------------------------+-------------------+
-| all() | Get ClientMetadata for all clients | List |
+| all_groups() | All known group names | List of strings |
++------------------------------+------------------------------------------------+-------------------+
+| all_groups_in_category(cat) | The names of all groups in category 'cat' | List of strings |
++------------------------------+------------------------------------------------+-------------------+
+| all() | Get ClientMetadata for all clients | List of |
+| | | ClientMetadata |
+------------------------------+------------------------------------------------+-------------------+