<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>bcfg2-lint.conf — Bcfg2 1.3.0 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.3.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/sidebar.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="top" title="Bcfg2 1.3.0 documentation" href="../index.html" />
<link rel="up" title="Man Pages" href="index.html" />
<link rel="next" title="bcfg2-reports" href="bcfg2-reports.html" />
<link rel="prev" title="bcfg2-lint" href="bcfg2-lint.html" />
<link rel="stylesheet" href="../_static/bcfg2.css" type=""/>
</head>
<body>
<div style="text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/bcfg2_logo.png" border="0" alt="sampledoc"/></a>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="bcfg2-reports.html" title="bcfg2-reports"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="bcfg2-lint.html" title="bcfg2-lint"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a> | </li>
<!--<li><a href="../search.html">search</a> | </li>-->
<li><a href="../help/index.html">help</a> | </li>
<li><a href="../contents.html">documentation </a> »</li>
<li><a href="../contents.html" >Bcfg2 documentation 1.3.0</a> »</li>
<li><a href="index.html" accesskey="U">Man Pages</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="bcfg2-lint-conf">
<h1>bcfg2-lint.conf<a class="headerlink" href="#bcfg2-lint-conf" title="Permalink to this headline">¶</a></h1>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>bcfg2-lint.conf includes configuration parameters for bcfg2-lint.</p>
</div>
<div class="section" id="file-format">
<h2>File format<a class="headerlink" href="#file-format" title="Permalink to this headline">¶</a></h2>
<p>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.</p>
<p>Options are specified in the form “name=value”.</p>
<p>The file is line-based each newline-terminated line represents either a
comment, a section name or an option.</p>
<p>Any line beginning with a hash (#) is ignored, as are lines containing
only whitespace.</p>
<p>The file consists of one <em>[lint]</em> section, up to one <em>[errors]</em> section,
and then any number of plugin-specific sections, documented below. (Note
that this makes it quite feasible to combine your <em>bcfg2-lint.conf</em> into
your <em class="manpage">bcfg2.conf(5)</em> file, if you so desire).</p>
</div>
<div class="section" id="global-options">
<h2>Global options<a class="headerlink" href="#global-options" title="Permalink to this headline">¶</a></h2>
<p>These options apply to <em>bcfg2-lint</em> generally, and must be in the
<em>[lint]</em> section.</p>
<dl class="docutils">
<dt>plugins</dt>
<dd>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 <em class="manpage">bcfg2-lint(8)</em> for a list of the available
plugins.</dd>
</dl>
</div>
<div class="section" id="error-handling">
<h2>Error handling<a class="headerlink" href="#error-handling" title="Permalink to this headline">¶</a></h2>
<p>Error handling is configured in the <em>[errors]</em> section. Each option
should be the name of an error and one of <em>error</em>, <em>warning</em>, or
<em>silent</em>, which tells <strong class="program">bcfg2-lint</strong> how to handle the
warning. Error names and their defaults can be displayed by running
<strong class="program">bcfg2-lint</strong> with the <em>–list-errors</em> option.</p>
</div>
<div class="section" id="plugin-options">
<h2>Plugin options<a class="headerlink" href="#plugin-options" title="Permalink to this headline">¶</a></h2>
<p>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 <em>[InfoXML]</em>.</p>
<p>If a plugin is not listed below, then it has no configuration.</p>
<p>In many cases, the behavior of a plugin can be configured by modifying
how errors from it are handled. See ERROR HANDLING, above.</p>
<div class="section" id="comments">
<h3>Comments<a class="headerlink" href="#comments" title="Permalink to this headline">¶</a></h3>
<p>The <em>Comments</em> plugin configuration specifies which VCS keywords and
comments are required for which file types. The valid types of file are
<em>global</em> (all file types), <em>bundler</em> (non-templated bundle files),
<em>genshibundler</em> (templated bundle files), <em>properties</em> (property files),
<em>cfg</em> (non-templated Cfg files), <em>genshi</em> or <em>cheetah</em> (templated Cfg
files), <em>infoxml</em> (info.xml files), and <em>probe</em> (probe files).</p>
<p>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.:</p>
<blockquote>
<div>cfg_keywords =</div></blockquote>
<p>By default, the <em>$Id$</em> keyword is checked for and nothing else.</p>
<p>Multiple keywords or comments should be comma-delimited.</p>
<blockquote>
<div><ul class="simple">
<li><em><type>_keywords</em></li>
</ul>
</div></blockquote>
<p>Ensure that files of the specified type have the given VCS keyword. Do
<em>not</em> include the dollar signs. I.e.:</p>
<blockquote>
<div>infoxml_keywords = Revision</div></blockquote>
<p><em>not</em></p>
<blockquote>
<div><p>infoxml_keywords = $Revision$</p>
<ul class="simple">
<li><em><type>_comments</em></li>
</ul>
</div></blockquote>
<p>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.</p>
</div>
<div class="section" id="infoxml">
<h3>InfoXML<a class="headerlink" href="#infoxml" title="Permalink to this headline">¶</a></h3>
<dl class="docutils">
<dt>required_attrs</dt>
<dd>A comma-delimited list of attributes to require on <em><Info></em> tags.
Default is “owner,group,mode”.</dd>
</dl>
</div>
<div class="section" id="mergefiles">
<h3>MergeFiles<a class="headerlink" href="#mergefiles" title="Permalink to this headline">¶</a></h3>
<dl class="docutils">
<dt>threshold</dt>
<dd>The threshold at which MergeFiles will suggest merging config files
and probes. Default is 75% similar.</dd>
</dl>
</div>
<div class="section" id="validate">
<h3>Validate<a class="headerlink" href="#validate" title="Permalink to this headline">¶</a></h3>
<dl class="docutils">
<dt>schema</dt>
<dd>The full path to the XML Schema files. Default is
<tt class="docutils literal"><span class="pre">/usr/share/bcfg2/schema</span></tt>. This can be overridden with the
<em>–schema</em> command-line option.</dd>
</dl>
</div>
</div>
<div class="section" id="see-also">
<h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<p><em class="manpage">bcfg2-lint(8)</em></p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">bcfg2-lint.conf</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#file-format">File format</a></li>
<li><a class="reference internal" href="#global-options">Global options</a></li>
<li><a class="reference internal" href="#error-handling">Error handling</a></li>
<li><a class="reference internal" href="#plugin-options">Plugin options</a><ul>
<li><a class="reference internal" href="#comments">Comments</a></li>
<li><a class="reference internal" href="#infoxml">InfoXML</a></li>
<li><a class="reference internal" href="#mergefiles">MergeFiles</a></li>
<li><a class="reference internal" href="#validate">Validate</a></li>
</ul>
</li>
<li><a class="reference internal" href="#see-also">See Also</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="bcfg2-lint.html"
title="previous chapter">bcfg2-lint</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="bcfg2-reports.html"
title="next chapter">bcfg2-reports</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/man/bcfg2-lint.conf.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="bcfg2-reports.html" title="bcfg2-reports"
>next</a> |</li>
<li class="right" >
<a href="bcfg2-lint.html" title="bcfg2-lint"
>previous</a> |</li>
<li><a href="../index.html">home</a> | </li>
<!--<li><a href="../search.html">search</a> | </li>-->
<li><a href="../help/index.html">help</a> | </li>
<li><a href="../contents.html">documentation </a> »</li>
<li><a href="../contents.html" >Bcfg2 documentation 1.3.0</a> »</li>
<li><a href="index.html" >Man Pages</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009-2013, Narayan Desai.
Last updated on Mar 20, 2013.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
b50d8ee6d7871fcc13c0677a9364ed59
>
files
>
399
