github doesn't like underscores.
This commit is contained in:
parent
bff13bfe87
commit
2aafae2db2
|
|
@ -8,8 +8,8 @@
|
|||
|
||||
<title><no title> — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
|
|
@ -20,9 +20,9 @@
|
|||
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/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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
|
|
|
|||
|
|
@ -0,0 +1,126 @@
|
|||
<!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><no title> — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.4',
|
||||
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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<dl class="docutils">
|
||||
<dt><strong>-o <linters>, –only=<linters></strong></dt>
|
||||
<dd>A comma-separated list of only those linters to run.</dd>
|
||||
<dt><strong>-x <linters> –exclude=<linters></strong></dt>
|
||||
<dd>A comma-separated list of linters to skip.</dd>
|
||||
<dt><strong>-l, –linters</strong></dt>
|
||||
<dd>Show the list of configured linters.</dd>
|
||||
<dt><strong>-b, –base</strong></dt>
|
||||
<dd>Check all changed files from GIT_DIR, not just those in the current directory and down.</dd>
|
||||
<dt><strong>-a, –all</strong></dt>
|
||||
<dd>Scan all files, not just those that have changed.</dd>
|
||||
<dt><strong>-e, –every</strong></dt>
|
||||
<dd>Scan all files, not just those that have changed, from GIT_DIR. Short for -b -a</dd>
|
||||
<dt><strong>-w, –workspace</strong></dt>
|
||||
<dd>Scan the workspace [default]</dd>
|
||||
<dt><strong>-s, –staging</strong></dt>
|
||||
<dd>Scan the staging area (useful for pre-commit).</dd>
|
||||
<dt><strong>-c <path>, –config=<path></strong></dt>
|
||||
<dd>Path to config file</dd>
|
||||
<dt><strong>-t, –bylinter</strong></dt>
|
||||
<dd>Group reports by linter first as they appear in the config file [default]</dd>
|
||||
<dt><strong>-f, –byfile</strong></dt>
|
||||
<dd>Group reports by file first, linter second</dd>
|
||||
<dt><strong>-d, –dryrun</strong></dt>
|
||||
<dd>Report what git-lint would do, but don’t actually do anything.</dd>
|
||||
<dt><strong>-q, –quiet</strong></dt>
|
||||
<dd>Produce a short report of file that failed to pass.</dd>
|
||||
<dt><strong>-h, –help</strong></dt>
|
||||
<dd>Print a short help message</dd>
|
||||
<dt><strong>-V, –verbose</strong></dt>
|
||||
<dd>Print a slightly more verbose long report</dd>
|
||||
<dt><strong>-v, –version</strong></dt>
|
||||
<dd>Print version information</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/arguments.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
10
authors.html
10
authors.html
|
|
@ -8,8 +8,8 @@
|
|||
|
||||
<title>Credits — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
|
|
@ -20,9 +20,9 @@
|
|||
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/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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
<link rel="next" title="History" href="history.html" />
|
||||
<link rel="prev" title="Contributing" href="contributing.html" />
|
||||
|
|
|
|||
|
|
@ -0,0 +1,134 @@
|
|||
<!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>Credits — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.4',
|
||||
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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
<link rel="next" title="History" href="history.html" />
|
||||
<link rel="prev" title="Contributing" href="contributing.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="history.html" title="History"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="contributing.html" title="Contributing"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="credits">
|
||||
<h1>Credits<a class="headerlink" href="#credits" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="development-lead">
|
||||
<h2>Development Lead<a class="headerlink" href="#development-lead" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Kenneth M. “Elf” Sternberg <<a class="reference external" href="mailto:elf.sternberg%40gmail.com">elf<span>.</span>sternberg<span>@</span>gmail<span>.</span>com</a>></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="contributors">
|
||||
<h2>Contributors<a class="headerlink" href="#contributors" title="Permalink to this headline">¶</a></h2>
|
||||
<p>None yet. Why not be the first?</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Credits</a><ul>
|
||||
<li><a class="reference internal" href="#development-lead">Development Lead</a></li>
|
||||
<li><a class="reference internal" href="#contributors">Contributors</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="contributing.html"
|
||||
title="previous chapter">Contributing</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="history.html"
|
||||
title="next chapter">History</a></p>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/authors.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="history.html" title="History"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="contributing.html" title="Contributing"
|
||||
>previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -8,8 +8,8 @@
|
|||
|
||||
<title>Contributing — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
|
|
@ -20,9 +20,9 @@
|
|||
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/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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
<link rel="next" title="Credits" href="authors.html" />
|
||||
<link rel="prev" title="Usage" href="usage.html" />
|
||||
|
|
|
|||
|
|
@ -0,0 +1,239 @@
|
|||
<!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>Contributing — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.4',
|
||||
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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
<link rel="next" title="Credits" href="authors.html" />
|
||||
<link rel="prev" title="Usage" href="usage.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="authors.html" title="Credits"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="usage.html" title="Usage"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="contributing">
|
||||
<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Contributions are welcome, and they are greatly appreciated! Every
|
||||
little bit helps, and credit will always be given.</p>
|
||||
<p>You can contribute in many ways:</p>
|
||||
<div class="section" id="types-of-contributions">
|
||||
<h2>Types of Contributions<a class="headerlink" href="#types-of-contributions" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="report-bugs">
|
||||
<h3>Report Bugs<a class="headerlink" href="#report-bugs" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Report bugs at <a class="reference external" href="https://github.com/elfsternberg/git_lint/issues">https://github.com/elfsternberg/git_lint/issues</a>.</p>
|
||||
<p>If you are reporting a bug, please include:</p>
|
||||
<ul class="simple">
|
||||
<li>Your operating system name and version.</li>
|
||||
<li>Any details about your local setup that might be helpful in troubleshooting.</li>
|
||||
<li>Detailed steps to reproduce the bug.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="fix-bugs">
|
||||
<h3>Fix Bugs<a class="headerlink" href="#fix-bugs" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Look through the GitHub issues for bugs. Anything tagged with “bug”
|
||||
is open to whoever wants to implement it.</p>
|
||||
</div>
|
||||
<div class="section" id="implement-features">
|
||||
<h3>Implement Features<a class="headerlink" href="#implement-features" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Look through the GitHub issues for features. Anything tagged with “feature”
|
||||
is open to whoever wants to implement it.</p>
|
||||
</div>
|
||||
<div class="section" id="write-documentation">
|
||||
<h3>Write Documentation<a class="headerlink" href="#write-documentation" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Git Lint could always use more documentation, whether as part of the
|
||||
official Git Lint docs, in docstrings, or even on the web in blog posts,
|
||||
articles, and such.</p>
|
||||
</div>
|
||||
<div class="section" id="submit-feedback">
|
||||
<h3>Submit Feedback<a class="headerlink" href="#submit-feedback" title="Permalink to this headline">¶</a></h3>
|
||||
<p>The best way to send feedback is to file an issue at <a class="reference external" href="https://github.com/elfsternberg/git_lint/issues">https://github.com/elfsternberg/git_lint/issues</a>.</p>
|
||||
<p>If you are proposing a feature:</p>
|
||||
<ul class="simple">
|
||||
<li>Explain in detail how it would work.</li>
|
||||
<li>Keep the scope as narrow as possible, to make it easier to implement.</li>
|
||||
<li>Remember that this is a volunteer-driven project, and that contributions
|
||||
are welcome :)</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="get-started">
|
||||
<h2>Get Started!<a class="headerlink" href="#get-started" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Ready to contribute? Here’s how to set up <cite>git_lint</cite> for local development.</p>
|
||||
<ol class="arabic">
|
||||
<li><p class="first">Fork the <cite>git_lint</cite> repo on GitHub.</p>
|
||||
</li>
|
||||
<li><p class="first">Clone your fork locally:</p>
|
||||
<div class="highlight-shell"><div class="highlight"><pre><span></span>$ git clone git@github.com:your_name_here/git_lint.git
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p class="first">Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:</p>
|
||||
<div class="highlight-shell"><div class="highlight"><pre><span></span>$ mkvirtualenv git_lint
|
||||
$ <span class="nb">cd</span> git_lint/
|
||||
$ python setup.py develop
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p class="first">Create a branch for local development:</p>
|
||||
<div class="highlight-shell"><div class="highlight"><pre><span></span>$ git checkout -b name-of-your-bugfix-or-feature
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Now you can make your changes locally.</p>
|
||||
</li>
|
||||
<li><p class="first">When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:</p>
|
||||
<div class="highlight-shell"><div class="highlight"><pre><span></span>$ flake8 git_lint tests
|
||||
$ python setup.py <span class="nb">test</span> or py.test
|
||||
$ tox
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>To get flake8 and tox, just pip install them into your virtualenv.</p>
|
||||
</li>
|
||||
<li><p class="first">Commit your changes and push your branch to GitHub:</p>
|
||||
<div class="highlight-shell"><div class="highlight"><pre><span></span>$ git add .
|
||||
$ git commit -m <span class="s2">"Your detailed description of your changes."</span>
|
||||
$ git push origin name-of-your-bugfix-or-feature
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p class="first">Submit a pull request through the GitHub website.</p>
|
||||
</li>
|
||||
</ol>
|
||||
</div>
|
||||
<div class="section" id="pull-request-guidelines">
|
||||
<h2>Pull Request Guidelines<a class="headerlink" href="#pull-request-guidelines" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Before you submit a pull request, check that it meets these guidelines:</p>
|
||||
<ol class="arabic simple">
|
||||
<li>The pull request should include tests.</li>
|
||||
<li>If the pull request adds functionality, the docs should be updated. Put
|
||||
your new functionality into a function with a docstring, and add the
|
||||
feature to the list in README.rst.</li>
|
||||
<li>The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
|
||||
<a class="reference external" href="https://travis-ci.org/elfsternberg/git_lint/pull_requests">https://travis-ci.org/elfsternberg/git_lint/pull_requests</a>
|
||||
and make sure that the tests pass for all supported Python versions.</li>
|
||||
</ol>
|
||||
</div>
|
||||
<div class="section" id="tips">
|
||||
<h2>Tips<a class="headerlink" href="#tips" title="Permalink to this headline">¶</a></h2>
|
||||
<p>To run a subset of tests:</p>
|
||||
<div class="highlight-shell"><div class="highlight"><pre><span></span>$ py.test tests.test_git_lint
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Contributing</a><ul>
|
||||
<li><a class="reference internal" href="#types-of-contributions">Types of Contributions</a><ul>
|
||||
<li><a class="reference internal" href="#report-bugs">Report Bugs</a></li>
|
||||
<li><a class="reference internal" href="#fix-bugs">Fix Bugs</a></li>
|
||||
<li><a class="reference internal" href="#implement-features">Implement Features</a></li>
|
||||
<li><a class="reference internal" href="#write-documentation">Write Documentation</a></li>
|
||||
<li><a class="reference internal" href="#submit-feedback">Submit Feedback</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#get-started">Get Started!</a></li>
|
||||
<li><a class="reference internal" href="#pull-request-guidelines">Pull Request Guidelines</a></li>
|
||||
<li><a class="reference internal" href="#tips">Tips</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="usage.html"
|
||||
title="previous chapter">Usage</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="authors.html"
|
||||
title="next chapter">Credits</a></p>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/contributing.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="authors.html" title="Credits"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="usage.html" title="Usage"
|
||||
>previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -9,8 +9,8 @@
|
|||
|
||||
<title>Index — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
|
|
@ -21,9 +21,9 @@
|
|||
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/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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
|
|
|
|||
|
|
@ -0,0 +1,333 @@
|
|||
|
||||
<!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>Index — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.4',
|
||||
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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="#" 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="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
|
||||
<h1 id="index">Index</h1>
|
||||
|
||||
<div class="genindex-jumpbox">
|
||||
<a href="#B"><strong>B</strong></a>
|
||||
| <a href="#C"><strong>C</strong></a>
|
||||
| <a href="#D"><strong>D</strong></a>
|
||||
| <a href="#E"><strong>E</strong></a>
|
||||
| <a href="#F"><strong>F</strong></a>
|
||||
| <a href="#G"><strong>G</strong></a>
|
||||
| <a href="#L"><strong>L</strong></a>
|
||||
| <a href="#M"><strong>M</strong></a>
|
||||
| <a href="#P"><strong>P</strong></a>
|
||||
| <a href="#R"><strong>R</strong></a>
|
||||
| <a href="#S"><strong>S</strong></a>
|
||||
| <a href="#W"><strong>W</strong></a>
|
||||
|
||||
</div>
|
||||
<h2 id="B">B</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.reporters.base_file_cleaner">base_file_cleaner() (in module git_lint.reporters)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="C">C</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.option_handler.cleanup_options">cleanup_options() (in module git_lint.option_handler)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="D">D</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.Linters.dryrun">dryrun() (git_lint.git_lint.Linters method)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="E">E</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.Linters.encode_shell_messages">encode_shell_messages() (git_lint.git_lint.Linters static method)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.executable_exists">executable_exists() (in module git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="F">F</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.find_config_file">find_config_file() (in module git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="G">G</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.get_filelist">get_filelist() (in module git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.get_git_base">get_git_base() (in module git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.get_git_head">get_git_head() (in module git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.get_git_response">get_git_response() (in module git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.get_git_response_raw">get_git_response_raw() (in module git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.get_linter_status">get_linter_status() (in module git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.get_shell_response">get_shell_response() (in module git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.get_working_linter_names">get_working_linter_names() (in module git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="git_lint.html#module-git_lint">git_lint (module)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="git_lint.html#module-git_lint.git_lint">git_lint.git_lint (module)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="git_lint.html#module-git_lint.option_handler">git_lint.option_handler (module)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="git_lint.html#module-git_lint.options">git_lint.options (module)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="git_lint.html#module-git_lint.reporters">git_lint.reporters (module)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.reporters.group_by">group_by() (in module git_lint.reporters)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="L">L</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.Linters">Linters (class in git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.load_config">load_config() (in module git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="M">M</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.MatchFilter.make_match_filter_matcher">make_match_filter_matcher() (git_lint.git_lint.MatchFilter static method)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.MatchFilter">MatchFilter (class in git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="P">P</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.reporters.print_help">print_help() (in module git_lint.reporters)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.reporters.print_linters">print_linters() (in module git_lint.reporters)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.reporters.print_report">print_report() (in module git_lint.reporters)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.reporters.print_version">print_version() (in module git_lint.reporters)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="R">R</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.Linters.run_external_linter">run_external_linter() (git_lint.git_lint.Linters static method)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.run_git_command">run_git_command() (in module git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.run_linters">run_linters() (in module git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.Linters.run_one_linter">run_one_linter() (git_lint.git_lint.Linters static method)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="S">S</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.split_git_response">split_git_response() (in module git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.StagingRunner">StagingRunner (class in git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="W">W</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="git_lint.html#git_lint.git_lint.WorkspaceRunner">WorkspaceRunner (class in git_lint.git_lint)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
|
||||
|
||||
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="#" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -8,8 +8,8 @@
|
|||
|
||||
<title>git_lint package — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
|
|
@ -20,9 +20,9 @@
|
|||
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/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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
|
|
|
|||
|
|
@ -0,0 +1,317 @@
|
|||
<!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>git_lint package — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.4',
|
||||
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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="git-lint-package">
|
||||
<h1>git_lint package<a class="headerlink" href="#git-lint-package" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-git_lint.git_lint">
|
||||
<span id="git-lint-git-lint-module"></span><h2>git_lint.git_lint module<a class="headerlink" href="#module-git_lint.git_lint" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="git_lint.git_lint.Linters">
|
||||
<em class="property">class </em><code class="descclassname">git_lint.git_lint.</code><code class="descname">Linters</code><span class="sig-paren">(</span><em>linters</em>, <em>filenames</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#Linters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.Linters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="git_lint.git_lint.Linters.dryrun">
|
||||
<code class="descname">dryrun</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#Linters.dryrun"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.Linters.dryrun" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="staticmethod">
|
||||
<dt id="git_lint.git_lint.Linters.encode_shell_messages">
|
||||
<em class="property">static </em><code class="descname">encode_shell_messages</code><span class="sig-paren">(</span><em>prefix</em>, <em>messages</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#Linters.encode_shell_messages"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.Linters.encode_shell_messages" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="staticmethod">
|
||||
<dt id="git_lint.git_lint.Linters.run_external_linter">
|
||||
<em class="property">static </em><code class="descname">run_external_linter</code><span class="sig-paren">(</span><em>filename</em>, <em>linter</em>, <em>linter_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#Linters.run_external_linter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.Linters.run_external_linter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Run one linter against one file.</p>
|
||||
<p>If the result matches the error condition specified in the configuration file,
|
||||
return the error code and messages, otherwise return nothing.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="staticmethod">
|
||||
<dt id="git_lint.git_lint.Linters.run_one_linter">
|
||||
<em class="property">static </em><code class="descname">run_one_linter</code><span class="sig-paren">(</span><em>linter</em>, <em>filenames</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#Linters.run_one_linter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.Linters.run_one_linter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Runs one linter against a set of files</p>
|
||||
<p>Creates a match filter for the linter, extract the files to be
|
||||
linted, and runs the linter against each file, returning the
|
||||
result as a list of successes and failures. Failures have a
|
||||
return code and the output of the lint process.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="git_lint.git_lint.MatchFilter">
|
||||
<em class="property">class </em><code class="descclassname">git_lint.git_lint.</code><code class="descname">MatchFilter</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#MatchFilter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.MatchFilter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="staticmethod">
|
||||
<dt id="git_lint.git_lint.MatchFilter.make_match_filter_matcher">
|
||||
<em class="property">static </em><code class="descname">make_match_filter_matcher</code><span class="sig-paren">(</span><em>extensions</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#MatchFilter.make_match_filter_matcher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.MatchFilter.make_match_filter_matcher" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="git_lint.git_lint.StagingRunner">
|
||||
<em class="property">class </em><code class="descclassname">git_lint.git_lint.</code><code class="descname">StagingRunner</code><span class="sig-paren">(</span><em>filenames</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#StagingRunner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.StagingRunner" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="git_lint.git_lint.WorkspaceRunner">
|
||||
<em class="property">class </em><code class="descclassname">git_lint.git_lint.</code><code class="descname">WorkspaceRunner</code><span class="sig-paren">(</span><em>filenames</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#WorkspaceRunner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.WorkspaceRunner" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.executable_exists">
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">executable_exists</code><span class="sig-paren">(</span><em>script</em>, <em>label</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#executable_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.executable_exists" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.find_config_file">
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">find_config_file</code><span class="sig-paren">(</span><em>options</em>, <em>base</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#find_config_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.find_config_file" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the configuration file from a prioritized list of locations.</p>
|
||||
<dl class="docutils">
|
||||
<dt>Locations are prioritized as:</dt>
|
||||
<dd><ol class="first last arabic simple">
|
||||
<li>From the command line. Fail if specified but not found</li>
|
||||
<li>The repository’s root directory, as the file .git-lint</li>
|
||||
<li>The repository’s root directory, as the file .git-lint/config</li>
|
||||
<li>The user’s home directory, as file .git-lint</li>
|
||||
<li>The user’s home directory, as the file .git-lint/config</li>
|
||||
</ol>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>If no configuration file is found, this is an error.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.get_filelist">
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">get_filelist</code><span class="sig-paren">(</span><em>options</em>, <em>extras</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#get_filelist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_filelist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the list of files against which we’ll run the linters.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.get_git_base">
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">get_git_base</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#get_git_base"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_git_base" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.get_git_head">
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">get_git_head</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#get_git_head"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_git_head" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.get_git_response">
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">get_git_response</code><span class="sig-paren">(</span><em>cmd</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#get_git_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_git_response" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.get_git_response_raw">
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">get_git_response_raw</code><span class="sig-paren">(</span><em>cmd</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#get_git_response_raw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_git_response_raw" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.get_linter_status">
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">get_linter_status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#get_linter_status"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_linter_status" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.get_shell_response">
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">get_shell_response</code><span class="sig-paren">(</span><em>fullcmd</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#get_shell_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_shell_response" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.get_working_linter_names">
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">get_working_linter_names</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#get_working_linter_names"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.get_working_linter_names" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.load_config">
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">load_config</code><span class="sig-paren">(</span><em>options</em>, <em>base</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#load_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.load_config" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Loads the git-lint configuration file.</p>
|
||||
<p>Returns the configuration file as a dictionary of dictionaries.
|
||||
Performs substitutions as specified in the SafeConfigParser
|
||||
specification; the only one performed currently is the ‘repodir’
|
||||
will be replaced with the base directory of the repository.
|
||||
Combined with the option to specify the .git-lint configuration as
|
||||
a directory, this allows users to keep per-project configuration
|
||||
files for specific linters.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.run_git_command">
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">run_git_command</code><span class="sig-paren">(</span><em>cmd</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#run_git_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.run_git_command" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.run_linters">
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">run_linters</code><span class="sig-paren">(</span><em>options</em>, <em>config</em>, <em>extras=[]</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#run_linters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.run_linters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.git_lint.split_git_response">
|
||||
<code class="descclassname">git_lint.git_lint.</code><code class="descname">split_git_response</code><span class="sig-paren">(</span><em>cmd</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/git_lint.html#split_git_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.git_lint.split_git_response" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-git_lint.option_handler">
|
||||
<span id="git-lint-option-handler-module"></span><h2>git_lint.option_handler module<a class="headerlink" href="#module-git_lint.option_handler" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="function">
|
||||
<dt id="git_lint.option_handler.cleanup_options">
|
||||
<code class="descclassname">git_lint.option_handler.</code><code class="descname">cleanup_options</code><span class="sig-paren">(</span><em>options</em>, <em>commandline</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/option_handler.html#cleanup_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.option_handler.cleanup_options" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="docutils">
|
||||
<dt>Takes a table of options and the commandline, and returns a</dt>
|
||||
<dd>dictionary of those options that appear on the commandline
|
||||
along with any extra arguments.</dd>
|
||||
<dt>:param List(Tuple (string, string, boolean, string, List(string))) options,</dt>
|
||||
<dd>The table of options: One-letter option, long option, takes arguments,
|
||||
Help text, list of (long) options superseded by this one.</dd>
|
||||
<dt>: param List(strings) commandline</dt>
|
||||
<dd>The arguments as received by the start-up process</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-git_lint.options">
|
||||
<span id="git-lint-options-module"></span><h2>git_lint.options module<a class="headerlink" href="#module-git_lint.options" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-git_lint.reporters">
|
||||
<span id="git-lint-reporters-module"></span><h2>git_lint.reporters module<a class="headerlink" href="#module-git_lint.reporters" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="function">
|
||||
<dt id="git_lint.reporters.base_file_cleaner">
|
||||
<code class="descclassname">git_lint.reporters.</code><code class="descname">base_file_cleaner</code><span class="sig-paren">(</span><em>files</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/reporters.html#base_file_cleaner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.base_file_cleaner" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.reporters.group_by">
|
||||
<code class="descclassname">git_lint.reporters.</code><code class="descname">group_by</code><span class="sig-paren">(</span><em>iterable</em>, <em>field_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/reporters.html#group_by"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.group_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.reporters.print_help">
|
||||
<code class="descclassname">git_lint.reporters.</code><code class="descname">print_help</code><span class="sig-paren">(</span><em>options</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/reporters.html#print_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.print_help" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.reporters.print_linters">
|
||||
<code class="descclassname">git_lint.reporters.</code><code class="descname">print_linters</code><span class="sig-paren">(</span><em>config</em>, <em>broken_linter_names</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/reporters.html#print_linters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.print_linters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.reporters.print_report">
|
||||
<code class="descclassname">git_lint.reporters.</code><code class="descname">print_report</code><span class="sig-paren">(</span><em>results</em>, <em>unlintable_filenames</em>, <em>cant_lint_filenames</em>, <em>broken_linter_names</em>, <em>unfindable_filenames</em>, <em>options={'bylinter': True}</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/reporters.html#print_report"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.print_report" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="git_lint.reporters.print_version">
|
||||
<code class="descclassname">git_lint.reporters.</code><code class="descname">print_version</code><span class="sig-paren">(</span><em>name</em>, <em>version</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/git_lint/reporters.html#print_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#git_lint.reporters.print_version" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-git_lint">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-git_lint" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">git_lint package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#module-git_lint.git_lint">git_lint.git_lint module</a></li>
|
||||
<li><a class="reference internal" href="#module-git_lint.option_handler">git_lint.option_handler module</a></li>
|
||||
<li><a class="reference internal" href="#module-git_lint.options">git_lint.options module</a></li>
|
||||
<li><a class="reference internal" href="#module-git_lint.reporters">git_lint.reporters module</a></li>
|
||||
<li><a class="reference internal" href="#module-git_lint">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/git_lint.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
10
history.html
10
history.html
|
|
@ -8,8 +8,8 @@
|
|||
|
||||
<title>History — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
|
|
@ -20,9 +20,9 @@
|
|||
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/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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
<link rel="prev" title="Credits" href="authors.html" />
|
||||
</head>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,122 @@
|
|||
<!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>History — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.4',
|
||||
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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
<link rel="prev" title="Credits" href="authors.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="authors.html" title="Credits"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="history">
|
||||
<h1>History<a class="headerlink" href="#history" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="id1">
|
||||
<h2>0.0.2 (2015-05-22)<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Pre-commit version</p>
|
||||
</div>
|
||||
<div class="section" id="id2">
|
||||
<h2>0.0.04 (2016-09-26)<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Moved to “git lint” and optioned the hell out of it.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">History</a><ul>
|
||||
<li><a class="reference internal" href="#id1">0.0.2 (2015-05-22)</a></li>
|
||||
<li><a class="reference internal" href="#id2">0.0.04 (2016-09-26)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="authors.html"
|
||||
title="previous chapter">Credits</a></p>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/history.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="authors.html" title="Credits"
|
||||
>previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,160 @@
|
|||
<!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>Welcome to Git Lint’s documentation! — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.4',
|
||||
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="Git Lint 0.0.4 documentation" href="#" />
|
||||
<link rel="next" title="Git Lint: README" href="readme.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="readme.html" title="Git Lint: README"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="#">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="welcome-to-git-lint-s-documentation">
|
||||
<h1>Welcome to Git Lint’s documentation!<a class="headerlink" href="#welcome-to-git-lint-s-documentation" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Contents:</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="readme.html">Git Lint: README</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="readme.html#usage">Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="readme.html#install">Install</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="readme.html#features">Features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="readme.html#acknowledgements">Acknowledgements</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="readme.html#disclaimer">Disclaimer</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="installation.html#stable-release">Stable release</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="installation.html#from-sources">From sources</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="usage.html#command-line">Command Line</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="usage.html#options">Options</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="usage.html#as-a-pre-commit-hook">As a pre-commit hook:</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="contributing.html#types-of-contributions">Types of Contributions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="contributing.html#get-started">Get Started!</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="contributing.html#pull-request-guidelines">Pull Request Guidelines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="contributing.html#tips">Tips</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="authors.html">Credits</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="authors.html#development-lead">Development Lead</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="authors.html#contributors">Contributors</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="history.html">History</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="history.html#id1">0.0.2 (2015-05-22)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="history.html#id2">0.0.04 (2016-09-26)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="indices-and-tables">
|
||||
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
|
||||
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
|
||||
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="#">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Welcome to Git Lint’s documentation!</a></li>
|
||||
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
|
||||
</ul>
|
||||
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="readme.html"
|
||||
title="next chapter">Git Lint: README</a></p>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/index.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="readme.html" title="Git Lint: README"
|
||||
>next</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="#">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -8,8 +8,8 @@
|
|||
|
||||
<title>Installation — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
|
|
@ -20,9 +20,9 @@
|
|||
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/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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
<link rel="next" title="Usage" href="usage.html" />
|
||||
<link rel="prev" title="Git Lint: README" href="readme.html" />
|
||||
|
|
|
|||
|
|
@ -0,0 +1,152 @@
|
|||
<!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>Installation — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.4',
|
||||
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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
<link rel="next" title="Usage" href="usage.html" />
|
||||
<link rel="prev" title="Git Lint: README" href="readme.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="usage.html" title="Usage"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="readme.html" title="Git Lint: README"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="installation">
|
||||
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="stable-release">
|
||||
<h2>Stable release<a class="headerlink" href="#stable-release" title="Permalink to this headline">¶</a></h2>
|
||||
<p>To install Git Lint, run this command in your terminal:</p>
|
||||
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> pip install git_linter
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If you don’t have <a class="reference external" href="https://pip.pypa.io">pip</a> installed, this <a class="reference external" href="http://docs.python-guide.org/en/latest/starting/installation/">Python installation guide</a> can guide
|
||||
you through the process.</p>
|
||||
</div>
|
||||
<div class="section" id="from-sources">
|
||||
<h2>From sources<a class="headerlink" href="#from-sources" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The sources for Git Lint can be downloaded from the <a class="reference external" href="https://github.com/elfsternberg/git_linter">Github repo</a>.</p>
|
||||
<p>You can either clone the public repository:</p>
|
||||
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> git clone git://github.com/elfsternberg/git_linter
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Or download the <a class="reference external" href="https://github.com/elfsternberg/git_linter/tarball/master">tarball</a>:</p>
|
||||
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> curl -OL https://github.com/elfsternberg/git_linter/tarball/master
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Once you have a copy of the source, you can install it with:</p>
|
||||
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> python setup.py install
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Once installed, please copy the ‘.git-lint’ example file. You may install this either in
|
||||
your home directory as <code class="docutils literal"><span class="pre">.git-lint</span></code> or in your project’s git directory as
|
||||
<code class="docutils literal"><span class="pre">.git/lint/git-lint</span></code></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Installation</a><ul>
|
||||
<li><a class="reference internal" href="#stable-release">Stable release</a></li>
|
||||
<li><a class="reference internal" href="#from-sources">From sources</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="readme.html"
|
||||
title="previous chapter">Git Lint: README</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="usage.html"
|
||||
title="next chapter">Usage</a></p>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/installation.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="usage.html" title="Usage"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="readme.html" title="Git Lint: README"
|
||||
>previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
10
manual.html
10
manual.html
|
|
@ -8,8 +8,8 @@
|
|||
|
||||
<title>git-lint(1) — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
|
|
@ -20,9 +20,9 @@
|
|||
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/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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
|
|
|
|||
|
|
@ -0,0 +1,187 @@
|
|||
<!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>git-lint(1) — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.4',
|
||||
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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="git-lint-1">
|
||||
<h1>git-lint(1)<a class="headerlink" href="#git-lint-1" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="name">
|
||||
<h2>NAME<a class="headerlink" href="#name" title="Permalink to this headline">¶</a></h2>
|
||||
<p>git-lint - Run configured linters against changed files</p>
|
||||
</div>
|
||||
<div class="section" id="synopsis">
|
||||
<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
|
||||
<p>[verse]
|
||||
<code class="docutils literal"><span class="pre">git</span> <span class="pre">lint</span></code> [<options>...] [<files...>]</p>
|
||||
</div>
|
||||
<div class="section" id="description">
|
||||
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Runs a list of configured linters against a specified list of files in
|
||||
your repository. By default all linters will be run against the
|
||||
changed files in your current workspace, from the current working
|
||||
directory on down. Command line options let you choose a different
|
||||
directory, a different of files, the complete set of files, and even
|
||||
the files currently in the staging area.</p>
|
||||
</div>
|
||||
<div class="section" id="options">
|
||||
<h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="docutils">
|
||||
<dt><strong>-o <linters>, –only=<linters></strong></dt>
|
||||
<dd>A comma-separated list of only those linters to run.</dd>
|
||||
<dt><strong>-x <linters> –exclude=<linters></strong></dt>
|
||||
<dd>A comma-separated list of linters to skip.</dd>
|
||||
<dt><strong>-l, –linters</strong></dt>
|
||||
<dd>Show the list of configured linters.</dd>
|
||||
<dt><strong>-b, –base</strong></dt>
|
||||
<dd>Check all changed files from GIT_DIR, not just those in the current directory and down.</dd>
|
||||
<dt><strong>-a, –all</strong></dt>
|
||||
<dd>Scan all files, not just those that have changed.</dd>
|
||||
<dt><strong>-e, –every</strong></dt>
|
||||
<dd>Scan all files, not just those that have changed, from GIT_DIR. Short for -b -a</dd>
|
||||
<dt><strong>-w, –workspace</strong></dt>
|
||||
<dd>Scan the workspace [default]</dd>
|
||||
<dt><strong>-s, –staging</strong></dt>
|
||||
<dd>Scan the staging area (useful for pre-commit).</dd>
|
||||
<dt><strong>-c <path>, –config=<path></strong></dt>
|
||||
<dd>Path to config file</dd>
|
||||
<dt><strong>-t, –bylinter</strong></dt>
|
||||
<dd>Group reports by linter first as they appear in the config file [default]</dd>
|
||||
<dt><strong>-f, –byfile</strong></dt>
|
||||
<dd>Group reports by file first, linter second</dd>
|
||||
<dt><strong>-d, –dryrun</strong></dt>
|
||||
<dd>Report what git-lint would do, but don’t actually do anything.</dd>
|
||||
<dt><strong>-q, –quiet</strong></dt>
|
||||
<dd>Produce a short report of file that failed to pass.</dd>
|
||||
<dt><strong>-h, –help</strong></dt>
|
||||
<dd>Print a short help message</dd>
|
||||
<dt><strong>-V, –verbose</strong></dt>
|
||||
<dd>Print a slightly more verbose long report</dd>
|
||||
<dt><strong>-v, –version</strong></dt>
|
||||
<dd>Print version information</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="output">
|
||||
<h2>OUTPUT<a class="headerlink" href="#output" title="Permalink to this headline">¶</a></h2>
|
||||
<p>By default, the output is that of all the linters specified, in the
|
||||
order in which they appear in the configuration file, followed by
|
||||
every file specified, sorted ASCIIbetically. This order can be
|
||||
flipped (files first, then linters) with the <code class="docutils literal"><span class="pre">--byfiles</span></code> option.</p>
|
||||
<p><code class="docutils literal"><span class="pre">git</span> <span class="pre">lint</span></code> returns the maximal error code if any linters fail a
|
||||
pass, or zero if they all succeed.</p>
|
||||
</div>
|
||||
<div class="section" id="configuration">
|
||||
<h2>CONFIGURATION<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
|
||||
<p><code class="docutils literal"><span class="pre">git</span> <span class="pre">lint</span></code> uses a standard INI-style configuration file. Aside from the
|
||||
DEFAULT section, the name of each section is an alphanumeric token name for
|
||||
a linter, followed by configuration details for that linter. Standard details
|
||||
are:</p>
|
||||
<ul class="simple">
|
||||
<li>output - Text to print before running a linter.</li>
|
||||
<li>command - The actual command to run, minus the file path</li>
|
||||
<li>match - A comma-separated list of extensions to match against the linter</li>
|
||||
<li>print - If true, will prefix each line of output from the linter with the filename</li>
|
||||
<li>condition - if “error”, the return code of the linter is the status of the pass. If “output,” any output will result in a failure.</li>
|
||||
<li>comment - Text to include when running the <code class="docutils literal"><span class="pre">--linters</span></code> option</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">git-lint(1)</a><ul>
|
||||
<li><a class="reference internal" href="#name">NAME</a></li>
|
||||
<li><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
|
||||
<li><a class="reference internal" href="#description">DESCRIPTION</a></li>
|
||||
<li><a class="reference internal" href="#options">OPTIONS</a></li>
|
||||
<li><a class="reference internal" href="#output">OUTPUT</a></li>
|
||||
<li><a class="reference internal" href="#configuration">CONFIGURATION</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/manual.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
10
modules.html
10
modules.html
|
|
@ -8,8 +8,8 @@
|
|||
|
||||
<title>git_lint — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
|
|
@ -20,9 +20,9 @@
|
|||
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/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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
|
|
|
|||
|
|
@ -0,0 +1,108 @@
|
|||
<!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>git_lint — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.4',
|
||||
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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="git-lint">
|
||||
<h1>git_lint<a class="headerlink" href="#git-lint" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="git_lint.html">git_lint package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="git_lint.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="git_lint.html#module-git_lint.git_lint">git_lint.git_lint module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="git_lint.html#module-git_lint.option_handler">git_lint.option_handler module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="git_lint.html#module-git_lint.options">git_lint.options module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="git_lint.html#module-git_lint.reporters">git_lint.reporters module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="git_lint.html#module-git_lint">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/modules.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -8,8 +8,8 @@
|
|||
|
||||
<title>Python Module Index — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
|
|
@ -20,9 +20,9 @@
|
|||
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/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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
|
||||
|
||||
|
|
@ -59,7 +59,7 @@
|
|||
<tr class="cap" id="cap-g"><td></td><td>
|
||||
<strong>g</strong></td><td></td></tr>
|
||||
<tr>
|
||||
<td><img src="_static/minus.png" class="toggler"
|
||||
<td><img src="static/minus.png" class="toggler"
|
||||
id="toggle-1" style="display: none" alt="-" /></td>
|
||||
<td>
|
||||
<a href="git_lint.html#module-git_lint"><code class="xref">git_lint</code></a></td><td>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,126 @@
|
|||
<!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>Python Module Index — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.4',
|
||||
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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="#" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
|
||||
<h1>Python Module Index</h1>
|
||||
|
||||
<div class="modindex-jumpbox">
|
||||
<a href="#cap-g"><strong>g</strong></a>
|
||||
</div>
|
||||
|
||||
<table class="indextable modindextable" cellspacing="0" cellpadding="2">
|
||||
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
||||
<tr class="cap" id="cap-g"><td></td><td>
|
||||
<strong>g</strong></td><td></td></tr>
|
||||
<tr>
|
||||
<td><img src="_static/minus.png" class="toggler"
|
||||
id="toggle-1" style="display: none" alt="-" /></td>
|
||||
<td>
|
||||
<a href="git_lint.html#module-git_lint"><code class="xref">git_lint</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="git_lint.html#module-git_lint.git_lint"><code class="xref">git_lint.git_lint</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="git_lint.html#module-git_lint.option_handler"><code class="xref">git_lint.option_handler</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="git_lint.html#module-git_lint.options"><code class="xref">git_lint.options</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="git_lint.html#module-git_lint.reporters"><code class="xref">git_lint.reporters</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
</table>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="#" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
10
readme.html
10
readme.html
|
|
@ -8,8 +8,8 @@
|
|||
|
||||
<title>Git Lint: README — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
|
|
@ -20,9 +20,9 @@
|
|||
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/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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
<link rel="next" title="Installation" href="installation.html" />
|
||||
<link rel="prev" title="Welcome to Git Lint’s documentation!" href="index.html" />
|
||||
|
|
|
|||
|
|
@ -0,0 +1,202 @@
|
|||
<!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>Git Lint: README — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.4',
|
||||
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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
<link rel="next" title="Installation" href="installation.html" />
|
||||
<link rel="prev" title="Welcome to Git Lint’s documentation!" href="index.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="installation.html" title="Installation"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="index.html" title="Welcome to Git Lint’s documentation!"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="git-lint-readme">
|
||||
<h1>Git Lint: README<a class="headerlink" href="#git-lint-readme" title="Permalink to this headline">¶</a></h1>
|
||||
<p>A git command that automatically runs identifiable linters against
|
||||
changed files in your current git repository or staging area.</p>
|
||||
<ul class="simple">
|
||||
<li>Free software: MIT license</li>
|
||||
</ul>
|
||||
<p><strong>Git Lint</strong> runs a configurable set of syntax, style, and complexity
|
||||
checkers against changed files in your current working directory or
|
||||
staging area. It can be configured to work with any <cite>lint</cite>-like
|
||||
command. Some commands may require shell wrappers.</p>
|
||||
<p>While it may be possible to create a custom lint command in your npm,
|
||||
grunt, Make, CMake, or whatever, the fact is we all use a VCS, and most
|
||||
of us use git. Having a centralized repository for what we want checked
|
||||
and how we want it checked, associated with git (and by extension, as a
|
||||
pre-commit hook), that can be run at any time for any reason.</p>
|
||||
<div class="section" id="usage">
|
||||
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="docutils">
|
||||
<dt>To lint only what’s changed recently in your current working directory:</dt>
|
||||
<dd><cite>git lint</cite></dd>
|
||||
<dt>To lint everything, changed or otherwise, from the current directory down:</dt>
|
||||
<dd><cite>git lint -a</cite></dd>
|
||||
<dt>To lint what’s changed from the repo’s base:</dt>
|
||||
<dd><cite>git lint -b</cite></dd>
|
||||
<dt>To lint what’s in your staging directory:</dt>
|
||||
<dd><cite>git lint -s</cite></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="install">
|
||||
<h2>Install<a class="headerlink" href="#install" title="Permalink to this headline">¶</a></h2>
|
||||
<blockquote>
|
||||
<div><cite>pip install git-linter</cite></div></blockquote>
|
||||
<p>You will need to copy the .git-lint configuration file to either your
|
||||
home directory or the repo`s base directory. Edit the configuration
|
||||
file as needed. You will also need any linters that you plan on
|
||||
running.</p>
|
||||
</div>
|
||||
<div class="section" id="features">
|
||||
<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Highly configurable - configuration files, both for git-lint and
|
||||
individual linters, can be global or per-project.</li>
|
||||
<li>Only checks files that have been changed, but this can be overriden
|
||||
from the command line.</li>
|
||||
<li>Can be used directly as a pre-commit hook, to ensure you personally
|
||||
don’t check in anything broken.<ul>
|
||||
<li>Used this way, it checks the <em>staging</em> area, not your workspace.</li>
|
||||
<li>When using the staging area, it stashes your current work. Upon
|
||||
restoration of your workspace, it ensures the timestamps are the
|
||||
same, so as not to confuse your build system or IDE.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="acknowledgements">
|
||||
<h2>Acknowledgements<a class="headerlink" href="#acknowledgements" title="Permalink to this headline">¶</a></h2>
|
||||
<p><cite>Git lint</cite> started life as a simple pre-commit hook. Most of the
|
||||
changes since were inspired by Steve Pulec’s <em>`Why You Need a Git
|
||||
Pre-Commit Hook and Why Most Are Wrong`_ ,</em> as well as just my own needs as
|
||||
a software developer.</p>
|
||||
</div>
|
||||
<div class="section" id="disclaimer">
|
||||
<h2>Disclaimer<a class="headerlink" href="#disclaimer" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This software, including provided configuration and documentation
|
||||
materials, is provided “as is” without any warranties, including any
|
||||
implied warranties of merchantability, fitness, performance, or
|
||||
quality. In no event shall the author or sponsor be liable for any
|
||||
special, direct, indirect, or consequential damages or any damages
|
||||
whatsoever resulting from loss of use, data or profits, whether in an
|
||||
action of contract, negligence or other tortious action, arising out
|
||||
of or in connection with the use or performance of this software.
|
||||
Each user of the program will agree and understand, and be deemed to
|
||||
have agreed and understood, that there is no warranty whatsoever for
|
||||
the program and, accordingly, the entire risk arising from or
|
||||
otherwise connected with the program is assumed by the user.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Git Lint: README</a><ul>
|
||||
<li><a class="reference internal" href="#usage">Usage</a></li>
|
||||
<li><a class="reference internal" href="#install">Install</a></li>
|
||||
<li><a class="reference internal" href="#features">Features</a></li>
|
||||
<li><a class="reference internal" href="#acknowledgements">Acknowledgements</a></li>
|
||||
<li><a class="reference internal" href="#disclaimer">Disclaimer</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="index.html"
|
||||
title="previous chapter">Welcome to Git Lint’s documentation!</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="installation.html"
|
||||
title="next chapter">Installation</a></p>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/readme.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="installation.html" title="Installation"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="index.html" title="Welcome to Git Lint’s documentation!"
|
||||
>previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
12
search.html
12
search.html
|
|
@ -8,8 +8,8 @@
|
|||
|
||||
<title>Search — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
|
|
@ -20,10 +20,10 @@
|
|||
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/searchtools.js"></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/searchtools.js"></script>
|
||||
<link rel="top" title="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
<script type="text/javascript">
|
||||
jQuery(function() { Search.loadIndex("searchindex.js"); });
|
||||
|
|
|
|||
|
|
@ -0,0 +1,105 @@
|
|||
<!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>Search — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.4',
|
||||
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/searchtools.js"></script>
|
||||
<link rel="top" title="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
<script type="text/javascript">
|
||||
jQuery(function() { Search.loadIndex("searchindex.js"); });
|
||||
</script>
|
||||
|
||||
<script type="text/javascript" id="searchindexloader"></script>
|
||||
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1 id="search-documentation">Search</h1>
|
||||
<div id="fallback" class="admonition warning">
|
||||
<script type="text/javascript">$('#fallback').hide();</script>
|
||||
<p>
|
||||
Please activate JavaScript to enable the search
|
||||
functionality.
|
||||
</p>
|
||||
</div>
|
||||
<p>
|
||||
From here you can search these documents. Enter your search
|
||||
words into the box below and click "search". Note that the search
|
||||
function will automatically search for all of the words. Pages
|
||||
containing fewer words won't appear in the result list.
|
||||
</p>
|
||||
<form action="" method="get">
|
||||
<input type="text" name="q" value="" />
|
||||
<input type="submit" value="search" />
|
||||
<span id="search-progress" style="padding-left: 10px"></span>
|
||||
</form>
|
||||
|
||||
<div id="search-results">
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -8,8 +8,8 @@
|
|||
|
||||
<title>Strategies — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
|
|
@ -20,9 +20,9 @@
|
|||
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/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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
|
|
|
|||
|
|
@ -0,0 +1,142 @@
|
|||
<!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>Strategies — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.4',
|
||||
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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="strategies">
|
||||
<h1>Strategies<a class="headerlink" href="#strategies" title="Permalink to this headline">¶</a></h1>
|
||||
<p>git-lint has a couple of phases in which it develops its strategy for what to run:</p>
|
||||
<ol class="arabic">
|
||||
<li><p class="first">Load the configuration file.
|
||||
a. On the command line?
|
||||
b. In the base directory as .git-lint?
|
||||
c. In the base directory as .git-lint/config?
|
||||
d. In the user’s home directory as .git-lint?
|
||||
e. In the user’s home directroy as .git-lint/config?</p>
|
||||
</li>
|
||||
<li><p class="first">Prune configuration with <code class="docutils literal"><span class="pre">-o</span></code> or <code class="docutils literal"><span class="pre">-e</span></code> options</p>
|
||||
</li>
|
||||
<li><p class="first">Determine which files to lint.
|
||||
a. Workspace or staging?</p>
|
||||
<blockquote>
|
||||
<div><ol class="lowerroman simple">
|
||||
<li>If staging, record all stashed timestamps for restoration</li>
|
||||
</ol>
|
||||
</div></blockquote>
|
||||
<ol class="loweralpha" start="2">
|
||||
<li><dl class="first docutils">
|
||||
<dt>From this list:</dt>
|
||||
<dd><ol class="first last lowerroman simple">
|
||||
<li>All changed files <code class="docutils literal"><span class="pre">-b</span></code></li>
|
||||
<li>All changed files in the current directory and down (default)</li>
|
||||
<li>All files in the current directory and down. <code class="docutils literal"><span class="pre">-a</span></code></li>
|
||||
<li>All files in the repository <code class="docutils literal"><span class="pre">-a</span> <span class="pre">-b</span></code></li>
|
||||
</ol>
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
<li><p class="first">Add files from command line, if any.</p>
|
||||
</li>
|
||||
<li><p class="first">Filter based on match criteria in configuration file.</p>
|
||||
</li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><p class="first">For each file, run the appropriate linter.
|
||||
a. If in delta mode <code class="docutils literal"><span class="pre">-d</span></code>, only show differences that correspond to user changes.
|
||||
b. Capture failure output and failure status.</p>
|
||||
</li>
|
||||
<li><p class="first">Reduce failure status to pass/fail</p>
|
||||
</li>
|
||||
<li><p class="first">Print resulting messages and exit with failure status (for pre-commit).</p>
|
||||
</li>
|
||||
<li><p class="first">If staging, unstage and touch-up files to restore timestamps.</p>
|
||||
</li>
|
||||
</ol>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/strategies.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
10
usage.html
10
usage.html
|
|
@ -8,8 +8,8 @@
|
|||
|
||||
<title>Usage — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
|
|
@ -20,9 +20,9 @@
|
|||
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/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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
<link rel="next" title="Contributing" href="contributing.html" />
|
||||
<link rel="prev" title="Installation" href="installation.html" />
|
||||
|
|
|
|||
|
|
@ -0,0 +1,159 @@
|
|||
<!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>Usage — Git Lint 0.0.4 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.4',
|
||||
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="Git Lint 0.0.4 documentation" href="index.html" />
|
||||
<link rel="next" title="Contributing" href="contributing.html" />
|
||||
<link rel="prev" title="Installation" href="installation.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="contributing.html" title="Contributing"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="installation.html" title="Installation"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="usage">
|
||||
<h1><a class="toc-backref" href="#id1">Usage</a><a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="command-line">
|
||||
<h2><a class="toc-backref" href="#id2">Command Line</a><a class="headerlink" href="#command-line" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="contents topic" id="contents">
|
||||
<p class="topic-title first">Contents</p>
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#usage" id="id1">Usage</a><ul>
|
||||
<li><a class="reference internal" href="#command-line" id="id2">Command Line</a></li>
|
||||
<li><a class="reference internal" href="#options" id="id3">Options</a></li>
|
||||
<li><a class="reference internal" href="#as-a-pre-commit-hook" id="id4">As a pre-commit hook:</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<p>git lint [options] [filenames]</p>
|
||||
</div>
|
||||
<div class="section" id="options">
|
||||
<h2><a class="toc-backref" href="#id3">Options</a><a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="as-a-pre-commit-hook">
|
||||
<h2><a class="toc-backref" href="#id4">As a pre-commit hook:</a><a class="headerlink" href="#as-a-pre-commit-hook" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python</span>
|
||||
<span class="kn">import</span> <span class="nn">git_lint</span>
|
||||
<span class="n">git_lint</span><span class="o">.</span><span class="n">run_precommit</span><span class="p">(</span><span class="n">staging</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span> <span class="n">timestamps</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Install this file in your project’s <code class="docutils literal"><span class="pre">.git/hooks/pre-commit</span></code>, and set
|
||||
the file’s executable flag to <code class="docutils literal"><span class="pre">true</span></code>:</p>
|
||||
<div class="highlight-shell"><div class="highlight"><pre><span></span>chmod +x pre-commit
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Please see the <span class="xref std std-ref">api</span> for more details on options taken by the
|
||||
<code class="docutils literal"><span class="pre">run_precommit()</span></code> and <code class="docutils literal"><span class="pre">run_gitlint</span></code> commands.</p>
|
||||
<p>There is an example <code class="docutils literal"><span class="pre">pre-commit</span></code> script shipped with <code class="docutils literal"><span class="pre">git</span> <span class="pre">lint</span></code>.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Usage</a><ul>
|
||||
<li><a class="reference internal" href="#command-line">Command Line</a></li>
|
||||
<li><a class="reference internal" href="#options">Options</a></li>
|
||||
<li><a class="reference internal" href="#as-a-pre-commit-hook">As a pre-commit hook:</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="installation.html"
|
||||
title="previous chapter">Installation</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="contributing.html"
|
||||
title="next chapter">Contributing</a></p>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/usage.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<div><input type="text" name="q" /></div>
|
||||
<div><input type="submit" value="Go" /></div>
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<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="contributing.html" title="Contributing"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="installation.html" title="Installation"
|
||||
>previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Reference in New Issue