summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2018-06-01 14:22:23 +0100
committerw0rp <devw0rp@gmail.com>2018-06-01 14:22:23 +0100
commit201f8519d97ff3805b8d35b683e4793a6d3209fa (patch)
treec1bb7ad5df99861cc4300ebcc1743fe538ef8357 /doc
parent6a7e00d9aca6aad374afcc8a64e322693bde55d8 (diff)
downloadale-201f8519d97ff3805b8d35b683e4793a6d3209fa.zip
Update the gitcommit documentation with more examples
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-gitcommit.txt10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/ale-gitcommit.txt b/doc/ale-gitcommit.txt
index 19ba8e94..38f3fd90 100644
--- a/doc/ale-gitcommit.txt
+++ b/doc/ale-gitcommit.txt
@@ -19,12 +19,14 @@ g:ale_gitcommit_gitlint_options *g:ale_gitcommit_gitlint_options*
Default: `''`
This variable can be changed to add command-line arguments to the gitlint
- invocation.
+ invocation. For example, you can specify the path to a configuration file. >
- For example, to dinamically set the gitlint configuration file path, you
- may want to set >
+ let g:ale_gitcommit_gitlint_options = '-C /home/user/.config/gitlint.ini'
+<
+ You can also disable particular error codes using this option. For example,
+ you can ignore errors for git commits with a missing body. >
- let g:ale_gitcommit_gitlint_options = '-C /home/user/.config/gitlint.ini'
+ let g:ale_gitcommit_gitlint_options = '--ignore B6'
<
g:ale_gitcommit_gitlint_use_global *g:ale_gitcommit_gitlint_use_global*