summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <w0rp@users.noreply.github.com>2018-06-06 21:31:36 +0100
committerGitHub <noreply@github.com>2018-06-06 21:31:36 +0100
commit67753de531c77586dd35c6aad093f3a68263601b (patch)
tree507190ec5e6bfa4f5c6c156b4857da097056f725 /doc
parentc49ea1a5e336f9b9e31a8de362b42f33aa79eb95 (diff)
parent20db9ab7197b6341644fcddc87f82c5731852ea8 (diff)
downloadale-67753de531c77586dd35c6aad093f3a68263601b.zip
Merge pull request #1632 from zed0/master
Add the cquery LSP
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-cpp.txt20
-rw-r--r--doc/ale.txt18
2 files changed, 37 insertions, 1 deletions
diff --git a/doc/ale-cpp.txt b/doc/ale-cpp.txt
index 05e54799..8bd111e4 100644
--- a/doc/ale-cpp.txt
+++ b/doc/ale-cpp.txt
@@ -157,6 +157,26 @@ g:ale_cpp_cpplint_options *g:ale_cpp_cpplint_options*
===============================================================================
+cquery *ale-cpp-cquery*
+
+g:ale_cpp_cquery_executable *g:ale_cpp_cquery_executable*
+ *b:ale_cpp_cquery_executable*
+ Type: |String|
+ Default: `'cquery'`
+
+ This variable can be changed to use a different executable for cquery.
+
+
+g:ale_cpp_cquery_cache_directory *g:ale_cpp_cquery_cache_directory*
+ *b:ale_cpp_cquery_cache_directory*
+ Type: |String|
+ Default: `'~/.cache/cquery'`
+
+ This variable can be changed to decide which directory cquery uses for its
+ cache.
+
+
+===============================================================================
flawfinder *ale-cpp-flawfinder*
g:ale_cpp_flawfinder_executable *g:ale_cpp_flawfinder_executable*
diff --git a/doc/ale.txt b/doc/ale.txt
index 66a81f3a..0531589c 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -44,6 +44,7 @@ CONTENTS *ale-contents*
clangtidy...........................|ale-cpp-clangtidy|
cppcheck............................|ale-cpp-cppcheck|
cpplint.............................|ale-cpp-cpplint|
+ cquery..............................|ale-cpp-cquery|
flawfinder..........................|ale-cpp-flawfinder|
gcc.................................|ale-cpp-gcc|
c#....................................|ale-cs-options|
@@ -319,7 +320,7 @@ Notes:
* Bash: `shell` (-n flag), `shellcheck`, `shfmt`
* Bourne Shell: `shell` (-n flag), `shellcheck`, `shfmt`
* C: `cppcheck`, `cpplint`!!, `clang`, `clangtidy`!!, `clang-format`, `flawfinder`, `gcc`
-* C++ (filetype cpp): `clang`, `clangcheck`!!, `clangtidy`!!, `clang-format`, `cppcheck`, `cpplint`!!, `flawfinder`, `gcc`
+* C++ (filetype cpp): `clang`, `clangcheck`!!, `clangtidy`!!, `clang-format`, `cppcheck`, `cpplint`!!, `cquery`, `flawfinder`, `gcc`
* CUDA: `nvcc`!!
* C#: `mcs`, `mcsc`!!
* Chef: `foodcritic`
@@ -2331,6 +2332,10 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
An optional `completion_filter` callback may be
defined for filtering completion results.
+ An optional `initialization_options` or
+ `initialization_options_callback` may be defined to
+ pass initialization options to the LSP.
+
`project_root_callback` A |String| or |Funcref| for a callback function
accepting a buffer number. A |String| should be
returned representing the path to the project for the
@@ -2372,6 +2377,17 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
setting can make it easier to guess the linter name
by offering a few alternatives.
+ `initialization_options` A |Dictionary| of initialization options for LSPs.
+ This will be fed (as JSON) to the LSP in the
+ initialize command.
+
+ `initialization_options_callback`
+ A |String| or |Funcref| for a callback function
+ accepting a buffer number. A |Dictionary| should be
+ returned for initialization options to pass the LSP.
+ This can be used in place of `initialization_options`
+ when more complicated processing is needed.
+
Only one of `command`, `command_callback`, or `command_chain` should be
specified. `command_callback` is generally recommended when a command string
needs to be generated dynamically, or any global options are used.