elf
/
git-linter
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
git-linter/docs/usage.rst

25 lines
457 B
ReStructuredText
Raw Normal View History

Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
=====
Usage
=====
Fixed usage inclusion.
2016-10-04 17:16:17 +00:00
Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
Command Line
------------
.. contents::
git lint [options] [filenames]
Options
-------
Trying to restructure this to be more sensible.
2016-09-28 17:01:02 +00:00
Fixed usage inclusion.
2016-10-04 17:16:17 +00:00
.. include:: arguments.rst
Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
Doing development in a side-file. Options and config files are now loaded sanely.
2016-09-20 21:59:20 +00:00
As a pre-commit hook:
---------------------
Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
Updating docs.
2016-10-05 20:11:49 +00:00
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.
A few more updates. Added new flags to usage.
2016-09-22 22:50:01 +00:00
Updating docs.
2016-10-05 20:11:49 +00:00
The pre-commit hook is *experimental*. Please be careful with it.