summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJoris Roovers <jroovers@cisco.com>2015-10-04 20:52:38 +0200
committerJoris Roovers <jroovers@cisco.com>2015-10-04 20:52:38 +0200
commitf623a0e90fdc50b4c30efdb3325fab3bb08f3a52 (patch)
tree4fc8d101a547bf73a870009d1710094798ab6e79 /README.md
parent207bf794dac9bff9c0597d0c2957a06071ca815d (diff)
Minor README and CHANGELOG changes
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 4 insertions, 7 deletions
diff --git a/README.md b/README.md
index c4ddc86..2670837 100644
--- a/README.md
+++ b/README.md
@@ -118,9 +118,9 @@ B7 | body-changed-file-mention | Body must contain references to certain fi
You can modify gitlint's behavior by specifying a config file like so:
```bash
-gitlint --config myconfigfile
+gitlint --config myconfigfile.ini
```
-By default, gitlint will look for an optional ```.gitlint``` file for configuration.
+By default, gitlint will look for an optional ```.gitlint``` config file.
```ini
# All these sections are optional, edit this file as you like.
@@ -185,13 +185,10 @@ gitlint-ignore: all
```
```gitlint-ignore: all``` can occur on any line, as long as it is at the start of the line. You can also specify
-specific rules to be ignore as follows: ```gitlint-ignore: T1, body-hard-tab```.
-
-**NOTE: gitlint currently does not support disabling \*specific\* rules on a per commit basis**
+specific rules to be ignored as follows: ```gitlint-ignore: T1, body-hard-tab```.
### Config precedence ###
-gitlint's behavior can be configured in a couple of different ways. Different config options take the following order
-of precedence:
+Configuring gitlint happens the following order of precedence:
1. Commit specific config (e.g.: ```gitlint-ignore: all``` in the commit message)
2. Commandline convenience flags (e.g.: ```-vv```, ```--silent```, ```--ignore```)