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/GroupPatterns.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/GroupPatterns.py')
-rw-r--r-- | src/lib/Bcfg2/Server/Plugins/GroupPatterns.py | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/src/lib/Bcfg2/Server/Plugins/GroupPatterns.py b/src/lib/Bcfg2/Server/Plugins/GroupPatterns.py index 8d1e50526..09685d972 100644 --- a/src/lib/Bcfg2/Server/Plugins/GroupPatterns.py +++ b/src/lib/Bcfg2/Server/Plugins/GroupPatterns.py @@ -129,7 +129,12 @@ class GroupPatterns(Bcfg2.Server.Plugin.Plugin, class GroupPatternsLint(Bcfg2.Server.Lint.ServerPlugin): - """ bcfg2-lint plugin for GroupPatterns """ + """ ``bcfg2-lint`` plugin to check all given :ref:`GroupPatterns + <server-plugins-grouping-grouppatterns>` patterns for validity. + This is simply done by trying to create a + :class:`Bcfg2.Server.Plugins.GroupPatterns.PatternMap` object for + each pattern, and catching exceptions and presenting them as + ``bcfg2-lint`` errors.""" def Run(self): cfg = self.core.plugins['GroupPatterns'].config |