diff options
| author | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2013-05-14 11:43:14 -0400 |
|---|---|---|
| committer | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2013-05-14 11:43:35 -0400 |
| commit | 34aff9f18f7a8ee59e8e07ceaf89d79bd6e96509 (patch) | |
| tree | a60979cded7755adf5324b1f83b074bce392f5bb /src/lib/Bcfg2/Server/Plugins/Bundler.py | |
| parent | 069f8ecb338f2c25acc2b80e1ab3be5560b28b77 (diff) | |
| download | bcfg2-34aff9f18f7a8ee59e8e07ceaf89d79bd6e96509.tar.gz bcfg2-34aff9f18f7a8ee59e8e07ceaf89d79bd6e96509.tar.bz2 bcfg2-34aff9f18f7a8ee59e8e07ceaf89d79bd6e96509.zip | |
doc: added devel docs for bcfg2-lint plugins
Diffstat (limited to 'src/lib/Bcfg2/Server/Plugins/Bundler.py')
| -rw-r--r-- | src/lib/Bcfg2/Server/Plugins/Bundler.py | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/src/lib/Bcfg2/Server/Plugins/Bundler.py b/src/lib/Bcfg2/Server/Plugins/Bundler.py index 5c5e3da0c..eef176cca 100644 --- a/src/lib/Bcfg2/Server/Plugins/Bundler.py +++ b/src/lib/Bcfg2/Server/Plugins/Bundler.py @@ -144,10 +144,10 @@ class Bundler(Bcfg2.Server.Plugin.Plugin, class BundlerLint(Bcfg2.Server.Lint.ServerPlugin): - """ Perform various bundle checks """ + """ Perform various :ref:`Bundler + <server-plugins-structures-bundler-index>` checks. """ def Run(self): - """ run plugin """ self.missing_bundles() for bundle in self.core.plugins['Bundler'].entries.values(): if (self.HandlesFile(bundle.name) and @@ -161,7 +161,8 @@ class BundlerLint(Bcfg2.Server.Lint.ServerPlugin): "inconsistent-bundle-name": "warning"} def missing_bundles(self): - """ find bundles listed in Metadata but not implemented in Bundler """ + """ Find bundles listed in Metadata but not implemented in + Bundler. """ if self.files is None: # when given a list of files on stdin, this check is # useless, so skip it @@ -180,7 +181,11 @@ class BundlerLint(Bcfg2.Server.Lint.ServerPlugin): bundle) def bundle_names(self, bundle): - """ verify bundle name attribute matches filename """ + """ Verify bundle name attribute matches filename. + + :param bundle: The bundle to verify + :type bundle: Bcfg2.Server.Plugins.Bundler.BundleFile + """ try: xdata = lxml.etree.XML(bundle.data) except AttributeError: |