summaryrefslogtreecommitdiff
path: root/doc/ale-proto.txt
diff options
context:
space:
mode:
authorBenjamin Bannier <bbannier@gmail.com>2018-01-06 20:56:28 +0100
committerBenjamin Bannier <bbannier@gmail.com>2018-01-07 17:56:56 +0100
commitb5a5cdf920a9875650b021c8116ac02b739a9e9e (patch)
tree34742878de3544cf25b27c57f3a6fd16ef7c590b /doc/ale-proto.txt
parenteecbacb742f0e884e2f47f0aee57caf9cb2dd683 (diff)
downloadale-b5a5cdf920a9875650b021c8116ac02b739a9e9e.zip
Make it possible to inject flags of protoc invocation.
Typically proto files depend on and make use of proto definitions in other files. When invoking protoc user can supply paths to inspect for dependencies. This patch makes it possible to configure flags passed to protoc. This makes it e.g., possible to change include paths of the linter's protoc invocation.
Diffstat (limited to 'doc/ale-proto.txt')
-rw-r--r--doc/ale-proto.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/ale-proto.txt b/doc/ale-proto.txt
index 6a256380..734e23d5 100644
--- a/doc/ale-proto.txt
+++ b/doc/ale-proto.txt
@@ -20,5 +20,14 @@ protoc-gen-lint *ale-proto-protoc-gen-lint*
The linter is a plugin for the `protoc` binary. As long as the binary resides
in the system path, `protoc` will find it.
+g:ale_proto_protoc_gen_lint_options *g:ale_proto_protoc_gen_lint_options*
+
+ Type: |String|
+ Default: `''`
+
+ This variable can be changed to modify flags given to protoc. Note that the
+ directory of the linted file is always passed as an include path with '-I'
+ before any user-supplied options.
+
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: