diff options
author | Yining <zhang.yining@gmail.com> | 2022-11-06 08:32:51 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-11-06 09:32:51 +0900 |
commit | edffffac2570cf837badf4195fb3d55ae439af7d (patch) | |
tree | 7bb57352a3f1224ceb5c05b8c3a74aaf513d7e46 /doc | |
parent | 07bd24d0fd767e9c584a45d43f23e8d5956665fe (diff) | |
download | ale-edffffac2570cf837badf4195fb3d55ae439af7d.zip |
add: support config option for checkmake linter (#4351)
`checkmake` by default checks config file "in the same folder it's
executed in" unless `--config` option is set.
This commit allows setting the `--config` option with an option
variable (with documentation updated).
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ale-make.txt | 18 | ||||
-rw-r--r-- | doc/ale.txt | 2 |
2 files changed, 20 insertions, 0 deletions
diff --git a/doc/ale-make.txt b/doc/ale-make.txt new file mode 100644 index 00000000..74de798f --- /dev/null +++ b/doc/ale-make.txt @@ -0,0 +1,18 @@ +=============================================================================== +ALE Make Integration *ale-make-options* + + +=============================================================================== +checkmake *ale-make-checkmake* + +g:ale_make_checkmake_config *g:ale_make_checkmake_config* + *b:ale_make_checkmake_config* + Type: |String| + Default: `''` + + This variable can be used to set the `--config` option of checkmake command. + if the value is empty, the checkmake command will not be invoked with the + option. + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index 4206d0ff..27d2c65c 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -3037,6 +3037,8 @@ documented in additional help files. luafmt................................|ale-lua-luafmt| selene................................|ale-lua-selene| stylua................................|ale-lua-stylua| + make....................................|ale-make-options| + checkmake.............................|ale-make-checkmake| markdown................................|ale-markdown-options| cspell................................|ale-markdown-cspell| dprint................................|ale-markdown-dprint| |