diff options
| author | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2012-09-18 13:40:11 -0400 |
|---|---|---|
| committer | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2012-09-20 11:37:55 -0400 |
| commit | 3e8826d66c23cc439df0a589f4c7821d2dfca575 (patch) | |
| tree | a4d1f489a135067ec6c0ad0e4564cb401b5f9cfa /src/lib/Bcfg2/Server/Plugins/Packages/Collection.py | |
| parent | 1587dcb17c310d5ffb22bd7060c1cf18696eba28 (diff) | |
| download | bcfg2-3e8826d66c23cc439df0a589f4c7821d2dfca575.tar.gz bcfg2-3e8826d66c23cc439df0a589f4c7821d2dfca575.tar.bz2 bcfg2-3e8826d66c23cc439df0a589f4c7821d2dfca575.zip | |
deduplicated Packages code, more docs
Diffstat (limited to 'src/lib/Bcfg2/Server/Plugins/Packages/Collection.py')
| -rw-r--r-- | src/lib/Bcfg2/Server/Plugins/Packages/Collection.py | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/src/lib/Bcfg2/Server/Plugins/Packages/Collection.py b/src/lib/Bcfg2/Server/Plugins/Packages/Collection.py index 31c832893..033eb2fc8 100644 --- a/src/lib/Bcfg2/Server/Plugins/Packages/Collection.py +++ b/src/lib/Bcfg2/Server/Plugins/Packages/Collection.py @@ -1,4 +1,4 @@ -"""``_Collection`` objects represent the set of +""" ``_Collection`` objects represent the set of :class:`Bcfg2.Server.Plugins.Packages.Source.Source` objects that apply to a given client, and can be used to query all software repositories for a client in aggregate. In some cases this can give faster or more @@ -35,7 +35,7 @@ In either case, you may want to override :func:`_Collection.filter_unknown`, and :func:`_Collection.build_extra_structures`. -.. _pkg-objects:: +.. _pkg-objects: Conversion Between Package Objects and XML Entries -------------------------------------------------- @@ -59,6 +59,9 @@ functions that take a package as an argument (e.g., In the documentation below, the actual parameter return type (usually .``string``) used in this base implementation is noted, as well as this fact. + +The Collection Module +--------------------- """ import sys @@ -447,7 +450,7 @@ class _Collection(list, Bcfg2.Server.Plugin.Debuggable): package(s) described by it in a format appropriate for passing to :func:`Bcfg2.Server.Plugins.Packages.Packages.complete`. By default, that's just the name; only the - :module:`Bcfg2.Server.Plugins.Packages.Yum` backend supports + :mod:`Bcfg2.Server.Plugins.Packages.Yum` backend supports versions or other extended data. See :ref:`pkg-objects` for more details. |