diff options
-rw-r--r-- | doc/man/bcfg2-lint.txt | 40 | ||||
-rw-r--r-- | examples/bcfg2-lint.conf | 4 | ||||
-rw-r--r-- | man/bcfg2-admin.8 | 2 | ||||
-rw-r--r-- | man/bcfg2-build-reports.8 | 2 | ||||
-rw-r--r-- | man/bcfg2-crypt.8 | 2 | ||||
-rw-r--r-- | man/bcfg2-info.8 | 2 | ||||
-rw-r--r-- | man/bcfg2-lint.8 | 42 | ||||
-rw-r--r-- | man/bcfg2-lint.conf.5 | 2 | ||||
-rw-r--r-- | man/bcfg2-reports.8 | 2 | ||||
-rw-r--r-- | man/bcfg2-server.8 | 2 | ||||
-rw-r--r-- | man/bcfg2.1 | 2 | ||||
-rw-r--r-- | man/bcfg2.conf.5 | 2 | ||||
-rwxr-xr-x | src/sbin/bcfg2-lint | 2 |
13 files changed, 47 insertions, 59 deletions
diff --git a/doc/man/bcfg2-lint.txt b/doc/man/bcfg2-lint.txt index b7206bd31..c15d62459 100644 --- a/doc/man/bcfg2-lint.txt +++ b/doc/man/bcfg2-lint.txt @@ -57,15 +57,10 @@ Options Plugins ------- -See :manpage:`bcfg2-lint.conf(5)` for more information on the -configuration of the plugins listed below. - -Bundles - Check the specification for several issues with Bundler: bundles - referenced in metadata but not found in *Bundler/*; bundles whose - *name* attribute does not match the filename; and Genshi template - bundles that use the *<Group>* tag (which is not processed in - templated bundles). +In addition to the plugins listed below, Bcfg2 server plugins may have +their own *bcfg2-lint* functionality, which is enabled automatically +when the server plugin is enabled. See :manpage:`bcfg2-lint.conf(5)` +for more information on lint plugin configuration. Comments Check the specification for VCS keywords and any comments that are @@ -77,9 +72,12 @@ Comments In XML files, only comments are checked for the keywords and comments required. -Duplicates - Check for several types of duplicates in the Metadata: duplicate - groups; duplicate clients; and multiple default groups. +Genshi + Ensure that all Genshi templates are valid and compile properly. + +GroupNames + Ensure that all groups called by name in Metadata, Rules, Bundler, + GroupPatterns, and Cfg are valid. InfoXML Check that certain attributes are specified in *info.xml* files. By @@ -91,14 +89,10 @@ MergeFiles Suggest that similar probes and config files be merged into single probes or TGenshi templates. -Pkgmgr - Check for duplicate packages specified in Pkgmgr. - RequiredAttrs - Check that all *Path* and *BoundPath* tags have the attributes that - are required by their type (e.g., a path of type symlink must have - name and to specified to be valid). This sort of validation is - beyond the scope of an XML schema. + Check that all entries have the appropriate required attributes, + and that the attributes are in a valid format. This goes above + and beyond the validation offered by an XML schema. Validate Validate the Bcfg2 specification against the XML schemas. @@ -113,10 +107,10 @@ Validate Bugs ---- -:program:`bcfg2-lint` may not handle some older plugins as well as it -handles newer ones. For instance, there may be some places where it -expects all of your configuration files to be handled by Cfg rather than -by a mix of Cfg and TGenshi or TCheetah. +:program:`bcfg2-lint` may not handle some deprecated plugins as well +as it handles newer ones. For instance, there may be some places where +it expects all of your configuration files to be handled by Cfg rather +than by a mix of Cfg and TGenshi or TCheetah. See Also -------- diff --git a/examples/bcfg2-lint.conf b/examples/bcfg2-lint.conf index 0fe99f967..5f49ab057 100644 --- a/examples/bcfg2-lint.conf +++ b/examples/bcfg2-lint.conf @@ -1,5 +1,5 @@ [lint] -plugins=Duplicates,InfoXML,Bundles,Comments,RequiredAttrs,Validate,MergeFiles +plugins=InfoXML,Comments,RequiredAttrs,Validate,MergeFiles [errors] no-infoxml=error @@ -18,7 +18,7 @@ genshibundler_comments = Properties,Probes,Description properties_comments = Template,Format genshi_comments = Maintainer,Properties,Probes,Description cheetah_comments = Maintainer,Properties,Probes,Description -cfg_comments = +cfg_comments = cfg_keywords = probe_comments = Maintainer,Purpose,Groups,Other Output diff --git a/man/bcfg2-admin.8 b/man/bcfg2-admin.8 index 008f56fa2..279ee7e0b 100644 --- a/man/bcfg2-admin.8 +++ b/man/bcfg2-admin.8 @@ -1,4 +1,4 @@ -.TH "BCFG2-ADMIN" "8" "November 14, 2012" "1.3" "Bcfg2" +.TH "BCFG2-ADMIN" "8" "January 14, 2013" "1.3" "Bcfg2" .SH NAME bcfg2-admin \- Perform repository administration tasks . diff --git a/man/bcfg2-build-reports.8 b/man/bcfg2-build-reports.8 index 1639adc74..8d3d58ebb 100644 --- a/man/bcfg2-build-reports.8 +++ b/man/bcfg2-build-reports.8 @@ -1,4 +1,4 @@ -.TH "BCFG2-BUILD-REPORTS" "8" "November 14, 2012" "1.3" "Bcfg2" +.TH "BCFG2-BUILD-REPORTS" "8" "January 14, 2013" "1.3" "Bcfg2" .SH NAME bcfg2-build-reports \- Generate state reports for Bcfg2 clients . diff --git a/man/bcfg2-crypt.8 b/man/bcfg2-crypt.8 index ab428c266..7c11eb66c 100644 --- a/man/bcfg2-crypt.8 +++ b/man/bcfg2-crypt.8 @@ -1,4 +1,4 @@ -.TH "BCFG2-CRYPT" "8" "November 14, 2012" "1.3" "Bcfg2" +.TH "BCFG2-CRYPT" "8" "January 14, 2013" "1.3" "Bcfg2" .SH NAME bcfg2-crypt \- Bcfg2 encryption and decryption utility . diff --git a/man/bcfg2-info.8 b/man/bcfg2-info.8 index 57c9e012c..ee650b5da 100644 --- a/man/bcfg2-info.8 +++ b/man/bcfg2-info.8 @@ -1,4 +1,4 @@ -.TH "BCFG2-INFO" "8" "November 14, 2012" "1.3" "Bcfg2" +.TH "BCFG2-INFO" "8" "January 14, 2013" "1.3" "Bcfg2" .SH NAME bcfg2-info \- Creates a local version of the Bcfg2 server core for state observation . diff --git a/man/bcfg2-lint.8 b/man/bcfg2-lint.8 index 01ba87a51..c81c305f1 100644 --- a/man/bcfg2-lint.8 +++ b/man/bcfg2-lint.8 @@ -1,4 +1,4 @@ -.TH "BCFG2-LINT" "8" "November 14, 2012" "1.3" "Bcfg2" +.TH "BCFG2-LINT" "8" "January 14, 2013" "1.3" "Bcfg2" .SH NAME bcfg2-lint \- Check Bcfg2 specification for validity, common mistakes, and style . @@ -85,17 +85,12 @@ included on stdin. .UNINDENT .SH PLUGINS .sp -See \fIbcfg2\-lint.conf(5)\fP for more information on the -configuration of the plugins listed below. +In addition to the plugins listed below, Bcfg2 server plugins may have +their own \fIbcfg2\-lint\fP functionality, which is enabled automatically +when the server plugin is enabled. See \fIbcfg2\-lint.conf(5)\fP +for more information on lint plugin configuration. .INDENT 0.0 .TP -.B Bundles -Check the specification for several issues with Bundler: bundles -referenced in metadata but not found in \fIBundler/\fP; bundles whose -\fIname\fP attribute does not match the filename; and Genshi template -bundles that use the \fI<Group>\fP tag (which is not processed in -templated bundles). -.TP .B Comments Check the specification for VCS keywords and any comments that are required. By default, this only checks that the \fI$Id$\fP keyword is @@ -106,9 +101,12 @@ you might require that every file have a "Maintainer" comment.) In XML files, only comments are checked for the keywords and comments required. .TP -.B Duplicates -Check for several types of duplicates in the Metadata: duplicate -groups; duplicate clients; and multiple default groups. +.B Genshi +Ensure that all Genshi templates are valid and compile properly. +.TP +.B GroupNames +Ensure that all groups called by name in Metadata, Rules, Bundler, +GroupPatterns, and Cfg are valid. .TP .B InfoXML Check that certain attributes are specified in \fIinfo.xml\fP files. By @@ -120,14 +118,10 @@ that paranoid mode be enabled for all files. Suggest that similar probes and config files be merged into single probes or TGenshi templates. .TP -.B Pkgmgr -Check for duplicate packages specified in Pkgmgr. -.TP .B RequiredAttrs -Check that all \fIPath\fP and \fIBoundPath\fP tags have the attributes that -are required by their type (e.g., a path of type symlink must have -name and to specified to be valid). This sort of validation is -beyond the scope of an XML schema. +Check that all entries have the appropriate required attributes, +and that the attributes are in a valid format. This goes above +and beyond the validation offered by an XML schema. .TP .B Validate Validate the Bcfg2 specification against the XML schemas. @@ -140,10 +134,10 @@ in \fIntp.xsd\fP schema validation will be performed on \fIntp.xml\fP. .UNINDENT .SH BUGS .sp -\fBbcfg2\-lint\fP may not handle some older plugins as well as it -handles newer ones. For instance, there may be some places where it -expects all of your configuration files to be handled by Cfg rather than -by a mix of Cfg and TGenshi or TCheetah. +\fBbcfg2\-lint\fP may not handle some deprecated plugins as well +as it handles newer ones. For instance, there may be some places where +it expects all of your configuration files to be handled by Cfg rather +than by a mix of Cfg and TGenshi or TCheetah. .SH SEE ALSO .sp \fIbcfg2(1)\fP, \fIbcfg2\-server(8)\fP, diff --git a/man/bcfg2-lint.conf.5 b/man/bcfg2-lint.conf.5 index d02b4e380..d6d299616 100644 --- a/man/bcfg2-lint.conf.5 +++ b/man/bcfg2-lint.conf.5 @@ -1,4 +1,4 @@ -.TH "BCFG2-LINT.CONF" "5" "November 14, 2012" "1.3" "Bcfg2" +.TH "BCFG2-LINT.CONF" "5" "January 14, 2013" "1.3" "Bcfg2" .SH NAME bcfg2-lint.conf \- Configuration parameters for bcfg2-lint . diff --git a/man/bcfg2-reports.8 b/man/bcfg2-reports.8 index 3b9e549e7..7b1622a5e 100644 --- a/man/bcfg2-reports.8 +++ b/man/bcfg2-reports.8 @@ -1,4 +1,4 @@ -.TH "BCFG2-REPORTS" "8" "November 14, 2012" "1.3" "Bcfg2" +.TH "BCFG2-REPORTS" "8" "January 14, 2013" "1.3" "Bcfg2" .SH NAME bcfg2-reports \- Query reporting system for client status . diff --git a/man/bcfg2-server.8 b/man/bcfg2-server.8 index 1fbbb0ec7..8df8ebfd5 100644 --- a/man/bcfg2-server.8 +++ b/man/bcfg2-server.8 @@ -1,4 +1,4 @@ -.TH "BCFG2-SERVER" "8" "November 14, 2012" "1.3" "Bcfg2" +.TH "BCFG2-SERVER" "8" "January 14, 2013" "1.3" "Bcfg2" .SH NAME bcfg2-server \- Server for client configuration specifications . diff --git a/man/bcfg2.1 b/man/bcfg2.1 index 6ee34831f..1e0f526c8 100644 --- a/man/bcfg2.1 +++ b/man/bcfg2.1 @@ -1,4 +1,4 @@ -.TH "BCFG2" "1" "November 14, 2012" "1.3" "Bcfg2" +.TH "BCFG2" "1" "January 14, 2013" "1.3" "Bcfg2" .SH NAME bcfg2 \- Bcfg2 client tool . diff --git a/man/bcfg2.conf.5 b/man/bcfg2.conf.5 index dfcb42a24..0a982b8f0 100644 --- a/man/bcfg2.conf.5 +++ b/man/bcfg2.conf.5 @@ -1,4 +1,4 @@ -.TH "BCFG2.CONF" "5" "November 26, 2012" "1.3" "Bcfg2" +.TH "BCFG2.CONF" "5" "January 14, 2013" "1.3" "Bcfg2" .SH NAME bcfg2.conf \- Configuration parameters for Bcfg2 . diff --git a/src/sbin/bcfg2-lint b/src/sbin/bcfg2-lint index a6efd0ccb..b041a0d31 100755 --- a/src/sbin/bcfg2-lint +++ b/src/sbin/bcfg2-lint @@ -88,7 +88,7 @@ def load_plugins(setup): if setup['args']: plugin_list = setup['args'] elif "bcfg2-repo-validate" in sys.argv[0]: - plugin_list = 'Duplicates,RequiredAttrs,Validate'.split(',') + plugin_list = 'RequiredAttrs,Validate'.split(',') else: try: plugin_list = setup.cfp.get('lint', 'plugins').split(',') |