/usr/share/doc/python-bashate-doc/html/readme.html is in python-bashate-doc 0.3.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 162 163 164 165 166 167 168 169 170 171 172 173 | <!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>bashate — bashate documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/tweaks.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '',
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>
<link rel="top" title="bashate documentation" href="index.html" />
<link rel="next" title="Installation" href="installation.html" />
<link rel="prev" title="Welcome to bashate’s documentation!" href="index.html" />
</head>
<body>
<div id="header">
<h1 id="logo"><a href="http://www.openstack.org/">OpenStack</a></h1>
<ul id="navigation">
<li><a href="http://www.openstack.org/" title="Go to the Home page" class="link">Home</a></li>
<li><a href="http://www.openstack.org/projects/" title="Go to the OpenStack Projects page">Projects</a></li>
<li><a href="http://www.openstack.org/user-stories/" title="Go to the User Stories page" class="link">User Stories</a></li>
<li><a href="http://www.openstack.org/community/" title="Go to the Community page" class="link">Community</a></li>
<li><a href="http://www.openstack.org/blog/" title="Go to the OpenStack Blog">Blog</a></li>
<li><a href="http://wiki.openstack.org/" title="Go to the OpenStack Wiki">Wiki</a></li>
<li><a href="http://docs.openstack.org/" title="Go to OpenStack Documentation" class="current">Documentation</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="bashate">
<h1>bashate<a class="headerlink" href="#bashate" title="Permalink to this headline">¶</a></h1>
<p>A pep8 equivalent for bash scripts</p>
<p>This program attempts to be an automated style checker for bash scripts
to fill the same part of code review that pep8 does in most OpenStack
projects. It started from humble beginnings in the DevStack project,
and will continue to evolve over time.</p>
<ul class="simple">
<li>Free software: Apache license</li>
<li>Documentation: <a class="reference external" href="http://docs.openstack.org/developer/bashate">http://docs.openstack.org/developer/bashate</a></li>
<li>Source: <a class="reference external" href="http://git.openstack.org/cgit/openstack-dev/bashate">http://git.openstack.org/cgit/openstack-dev/bashate</a></li>
<li>Bugs: <a class="reference external" href="http://bugs.launchpad.net/bash8">http://bugs.launchpad.net/bash8</a></li>
</ul>
<div class="section" id="currently-supported-checks">
<h2>Currently Supported Checks<a class="headerlink" href="#currently-supported-checks" title="Permalink to this headline">¶</a></h2>
<div class="section" id="errors">
<h3>Errors<a class="headerlink" href="#errors" title="Permalink to this headline">¶</a></h3>
<p>Basic white space errors, for consistent indenting</p>
<ul class="simple">
<li>E001: check that lines do not end with trailing whitespace</li>
<li>E002: ensure that indents are only spaces, and not hard tabs</li>
<li>E003: ensure all indents are a multiple of 4 spaces</li>
<li>E004: file did not end with a newline</li>
</ul>
</div>
<div class="section" id="structure-errors">
<h3>Structure Errors<a class="headerlink" href="#structure-errors" title="Permalink to this headline">¶</a></h3>
<p>A set of rules that help keep things consistent in control blocks.
These are ignored on long lines that have a continuation, because
unrolling that is kind of “interesting”</p>
<ul class="simple">
<li>E010: <em>do</em> not on the same line as <em>for</em></li>
<li>E011: <em>then</em> not on the same line as <em>if</em> or <em>elif</em></li>
<li>E012: heredoc didn’t end before EOF</li>
<li>E020: Function declaration not in format <tt class="docutils literal"><span class="pre">^function</span> <span class="pre">name</span> <span class="pre">{$</span></tt></li>
</ul>
</div>
<div class="section" id="obsolete-and-deprecated-syntax">
<h3>Obsolete and deprecated syntax<a class="headerlink" href="#obsolete-and-deprecated-syntax" title="Permalink to this headline">¶</a></h3>
<p>Rules to identify obsolete and deprecated syntax that should not be used</p>
<ul class="simple">
<li>E041: Usage of $[ for arithmetic is deprecated for $((</li>
</ul>
</div>
<div class="section" id="see-also">
<h3>See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h3>
<p>See also <a class="reference internal" href="man/bashate.html"><em>bashate man page</em></a>.</p>
</div>
</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="#">bashate</a><ul>
<li><a class="reference internal" href="#currently-supported-checks">Currently Supported Checks</a><ul>
<li><a class="reference internal" href="#errors">Errors</a></li>
<li><a class="reference internal" href="#structure-errors">Structure Errors</a></li>
<li><a class="reference internal" href="#obsolete-and-deprecated-syntax">Obsolete and deprecated syntax</a></li>
<li><a class="reference internal" href="#see-also">See also</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Welcome to bashate’s documentation!</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="installation.html"
title="next chapter">Installation</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/readme.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" size="18" />
<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"
accesskey="I">index</a></li>
<li class="right" >
<a href="installation.html" title="Installation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to bashate’s documentation!"
accesskey="P">previous</a> |</li>
<li><a href="index.html">bashate documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2014, Bashate Authors.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>
|