1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
.TH "BCFG2-LINT.CONF" "5" "March 18, 2013" "1.3" "Bcfg2"
.SH NAME
bcfg2-lint.conf \- Configuration parameters for bcfg2-lint
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructuredText.
.
.SH DESCRIPTION
.sp
bcfg2\-lint.conf includes configuration parameters for bcfg2\-lint.
.SH FILE FORMAT
.sp
The file is INI\-style and consists of sections and options. A section
begins with the name of the sections in square brackets and continues
until the next section begins.
.sp
Options are specified in the form "name=value".
.sp
The file is line\-based each newline\-terminated line represents either a
comment, a section name or an option.
.sp
Any line beginning with a hash (#) is ignored, as are lines containing
only whitespace.
.sp
The file consists of one \fI[lint]\fP section, up to one \fI[errors]\fP section,
and then any number of plugin\-specific sections, documented below. (Note
that this makes it quite feasible to combine your \fIbcfg2\-lint.conf\fP into
your \fIbcfg2.conf(5)\fP file, if you so desire).
.SH GLOBAL OPTIONS
.sp
These options apply to \fIbcfg2\-lint\fP generally, and must be in the
\fI[lint]\fP section.
.INDENT 0.0
.TP
.B plugins
A comma\-delimited list of plugins to run. By default, all plugins
are run. This can be overridden by listing plugins on the command
line. See \fIbcfg2\-lint(8)\fP for a list of the available
plugins.
.UNINDENT
.SH ERROR HANDLING
.sp
Error handling is configured in the \fI[errors]\fP section. Each option
should be the name of an error and one of \fIerror\fP, \fIwarning\fP, or
\fIsilent\fP, which tells \fBbcfg2\-lint\fP how to handle the
warning. Error names and their defaults can be displayed by running
\fBbcfg2\-lint\fP with the \fI\-\-list\-errors\fP option.
.SH PLUGIN OPTIONS
.sp
These options apply only to a single plugin. Each option should be in a
section named for its plugin; for instance, options for the InfoXML
plugin would be in a section called \fI[InfoXML]\fP.
.sp
If a plugin is not listed below, then it has no configuration.
.sp
In many cases, the behavior of a plugin can be configured by modifying
how errors from it are handled. See ERROR HANDLING, above.
.SS Comments
.sp
The \fIComments\fP plugin configuration specifies which VCS keywords and
comments are required for which file types. The valid types of file are
\fIglobal\fP (all file types), \fIbundler\fP (non\-templated bundle files),
\fIgenshibundler\fP (templated bundle files), \fIproperties\fP (property files),
\fIcfg\fP (non\-templated Cfg files), \fIgenshi\fP or \fIcheetah\fP (templated Cfg
files), \fIinfoxml\fP (info.xml files), and \fIprobe\fP (probe files).
.sp
The specific types (i.e., types other than "global") all supplement
global; they do not override it. The exception is if you specify an
empty option, e.g.:
.INDENT 0.0
.INDENT 3.5
cfg_keywords =
.UNINDENT
.UNINDENT
.sp
By default, the \fI$Id$\fP keyword is checked for and nothing else.
.sp
Multiple keywords or comments should be comma\-delimited.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fI<type>_keywords\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Ensure that files of the specified type have the given VCS keyword. Do
\fInot\fP include the dollar signs. I.e.:
.INDENT 0.0
.INDENT 3.5
infoxml_keywords = Revision
.UNINDENT
.UNINDENT
.sp
\fInot\fP
.INDENT 0.0
.INDENT 3.5
infoxml_keywords = $Revision$
.INDENT 0.0
.IP \(bu 2
\fI<type>_comments\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Ensure that files of the specified type have a comment containing the
given string. In XML files, only comments are checked. In plain text
files, all lines are checked since comment characters may vary.
.SS InfoXML
.INDENT 0.0
.TP
.B required_attrs
A comma\-delimited list of attributes to require on \fI<Info>\fP tags.
Default is "owner,group,mode".
.UNINDENT
.SS MergeFiles
.INDENT 0.0
.TP
.B threshold
The threshold at which MergeFiles will suggest merging config files
and probes. Default is 75% similar.
.UNINDENT
.SS Validate
.INDENT 0.0
.TP
.B schema
The full path to the XML Schema files. Default is
\fB/usr/share/bcfg2/schema\fP. This can be overridden with the
\fI\-\-schema\fP command\-line option.
.UNINDENT
.SH SEE ALSO
.sp
\fIbcfg2\-lint(8)\fP
.\" Generated by docutils manpage writer.
.
|
