From 201f8519d97ff3805b8d35b683e4793a6d3209fa Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 1 Jun 2018 14:22:23 +0100 Subject: [PATCH] Update the gitcommit documentation with more examples --- doc/ale-gitcommit.txt | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/ale-gitcommit.txt b/doc/ale-gitcommit.txt index 19ba8e9..38f3fd9 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*