Updating docs.

This commit is contained in:
Elf M. Sternberg 2016-10-05 13:11:49 -07:00
parent 74d217d6fe
commit 3461709ebf
3 changed files with 11 additions and 18 deletions

View File

@ -10,3 +10,4 @@ recursive-exclude * *.py[co]
recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif *.1 recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif *.1
include docs/_build/man/git-lint.1 include docs/_build/man/git-lint.1
include bin/pre-commit bin/git-lint-style

View File

@ -3,8 +3,12 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to Git Lint's documentation! Git Lint
====================================== ========
Git Lint provides a new git command that automatically runs identifiable linters (style
and syntax quality assurance programs) against changed files in your current git
repository or staging area.
Contents: Contents:

View File

@ -17,20 +17,8 @@ Options
As a pre-commit hook: As a pre-commit hook:
--------------------- ---------------------
.. code-block:: python There's a file, pre-commit, in the /bin directory with the project. (Or you can download
it from the github repository.) Install it in you .git/hooks/pre-commit file, and
chmod +x .git/hooks/pre-commit.
#!/usr/bin/env python The pre-commit hook is *experimental*. Please be careful with it.
import git_lint
git_lint.run_precommit(staging = True, timestamps = True)
Install this file in your project's ``.git/hooks/pre-commit``, and set
the file's executable flag to ``true``:
.. code-block:: shell
chmod +x pre-commit
Please see the :ref:`api` for more details on options taken by the
``run_precommit()`` and ``run_gitlint`` commands.
There is an example ``pre-commit`` script shipped with ``git lint``.