Update the gitcommit documentation with more examples

This commit is contained in:
w0rp 2018-06-01 14:22:23 +01:00
parent 6a7e00d9ac
commit 201f8519d9
No known key found for this signature in database
GPG Key ID: 0FC1ECAA8C81CD83

View File

@ -19,13 +19,15 @@ g:ale_gitcommit_gitlint_options *g:ale_gitcommit_gitlint_options*
Default: `''` Default: `''`
This variable can be changed to add command-line arguments to the gitlint 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' 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 = '--ignore B6'
<
g:ale_gitcommit_gitlint_use_global *g:ale_gitcommit_gitlint_use_global* g:ale_gitcommit_gitlint_use_global *g:ale_gitcommit_gitlint_use_global*
*b:ale_gitcommit_gitlint_use_global* *b:ale_gitcommit_gitlint_use_global*