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/Lint/InfoXML.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/Lint/InfoXML.py')
| -rw-r--r-- | src/lib/Bcfg2/Server/Lint/InfoXML.py | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/src/lib/Bcfg2/Server/Lint/InfoXML.py b/src/lib/Bcfg2/Server/Lint/InfoXML.py index e34f387ff..95657317e 100644 --- a/src/lib/Bcfg2/Server/Lint/InfoXML.py +++ b/src/lib/Bcfg2/Server/Lint/InfoXML.py @@ -1,4 +1,4 @@ -""" ensure that all config files have an info.xml file""" +""" Ensure that all config files have a valid info.xml file. """ import os import Bcfg2.Options @@ -8,7 +8,14 @@ from Bcfg2.Server.Plugins.Cfg.CfgLegacyInfo import CfgLegacyInfo class InfoXML(Bcfg2.Server.Lint.ServerPlugin): - """ ensure that all config files have an info.xml file""" + """ Ensure that all config files have a valid info.xml file. This + plugin can check for: + + * Missing ``info.xml`` files; + * Use of deprecated ``info``/``:info`` files; + * Paranoid mode disabled in an ``info.xml`` file; + * Required attributes missing from ``info.xml`` + """ def Run(self): if 'Cfg' not in self.core.plugins: return @@ -40,11 +47,10 @@ class InfoXML(Bcfg2.Server.Lint.ServerPlugin): return {"no-infoxml": "warning", "deprecated-info-file": "warning", "paranoid-false": "warning", - "broken-xinclude-chain": "warning", "required-infoxml-attrs-missing": "error"} def check_infoxml(self, fname, xdata): - """ verify that info.xml contains everything it should """ + """ Verify that info.xml contains everything it should. """ for info in xdata.getroottree().findall("//Info"): required = [] if "required_attrs" in self.config: |