ryuslash/commit-check
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README

Browse source
This commit is contained in:
Tom Willemse 2014-04-12 13:46:30 +02:00
parent 35b7e1fba0
commit 135c366f62
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.org
View file

@ -33,23 +33,23 @@
executable, or a script running this program (passing along all
arguments).
*** Usage
** Usage
When used as a git ~commit-msg~ hook it should just be a question of
getting it in the right place and it'll work. If, however, you
have another use for it and need to run it manually, there are
some command-line options that you can use:
When used as a git ~commit-msg~ hook it should just be a question of
getting it in the right place and it'll work. If, however, you
have another use for it and need to run it manually, there are
some command-line options that you can use:
- =-h= :: Show a short help message to help you along.
- =-0= :: Always exit with a ~0~ exit status.
- =-h= :: Show a short help message to help you along.
- =-0= :: Always exit with a ~0~ exit status.
Some tools, such as the before-mentioned Flycheck, don't like it
when the back-end tool exits with a non-zero exit status and think
that means that the tool failed to run. To keep such tools happy
the =-0= can be used.
Some tools, such as the before-mentioned Flycheck, don't like it
when the back-end tool exits with a non-zero exit status and think
that means that the tool failed to run. To keep such tools happy
the =-0= can be used.
commit check expects the file to check as the last argument on the
command line (or actually, the first non-option argument).
commit check expects the file to check as the last argument on the
command line (or actually, the first non-option argument).
** License