diff options
| author | w0rp <devw0rp@gmail.com> | 2018-06-01 14:22:23 +0100 |
|---|---|---|
| committer | w0rp <devw0rp@gmail.com> | 2018-06-01 14:26:58 +0100 |
| commit | fd49c2d2070c29738a2a6e7ba86c8128341eb93d (patch) | |
| tree | c1bb7ad5df99861cc4300ebcc1743fe538ef8357 | |
| parent | f66027c49ee7741aeac7b0a91e42b3fe67247b67 (diff) | |
| download | ale-fd49c2d2070c29738a2a6e7ba86c8128341eb93d.zip | |
Update the gitcommit documentation with more examples
| -rw-r--r-- | doc/ale-gitcommit.txt | 10 |
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* |