summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSven-Hendrik Haase <svenstaro@gmail.com>2017-09-08 19:06:47 +0900
committerw0rp <w0rp@users.noreply.github.com>2017-09-08 11:06:47 +0100
commitff288366165804e8956013cca8c1291536cf9707 (patch)
tree1e8957d04b4b3da3680f6b77478acab39018782b /doc
parent73d031d7eacba95c68287eddb52fb0b73947ba05 (diff)
downloadale-ff288366165804e8956013cca8c1291536cf9707.zip
Add GLSL linter using glslang (#914)
* Add a glslang linter for GLSL
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-glsl.txt36
-rw-r--r--doc/ale.txt3
2 files changed, 39 insertions, 0 deletions
diff --git a/doc/ale-glsl.txt b/doc/ale-glsl.txt
new file mode 100644
index 00000000..fbadf03c
--- /dev/null
+++ b/doc/ale-glsl.txt
@@ -0,0 +1,36 @@
+===============================================================================
+ALE GLSL Integration *ale-glsl-options*
+ *ale-integration-glsl*
+
+===============================================================================
+Integration Information
+
+ Since Vim does not detect the glsl file types out-of-the-box, you need the
+ runtime files for glsl from here: https://github.com/tikhomirov/vim-glsl
+
+ Note that the current glslang-based linter expects glslangValidator in
+ standard paths. If it's not installed system-wide you can set
+ |g:ale_glsl_glslang_executable| to a specific path.
+
+
+===============================================================================
+glslang *ale-glsl-glslang*
+
+g:ale_glsl_glslang_executable *g:ale_glsl_glslang_executable*
+ *b:ale_glsl_glslang_executable*
+ Type: |String|
+ Default: `'glslangValidator'`
+
+ This variable can be changed to change the path to glslangValidator.
+
+
+g:ale_glsl_glslang_options *g:ale_glsl_glslang_options*
+ *b:ale_glsl_glslang_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to glslangValidator.
+
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale.txt b/doc/ale.txt
index 44d9e0ff..319c109e 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -49,6 +49,8 @@ CONTENTS *ale-contents*
gcc.................................|ale-fortran-gcc|
fusionscript..........................|ale-fuse-options|
fusion-lint.........................|ale-fuse-fusionlint|
+ glsl..................................|ale-glsl-options|
+ glslang.............................|ale-glsl-glslang|
go....................................|ale-go-options|
gometalinter........................|ale-go-gometalinter|
graphql...............................|ale-graphql-options|
@@ -220,6 +222,7 @@ Notes:
* Erlang: `erlc`, `SyntaxErl`
* Fortran: `gcc`
* FusionScript: `fusion-lint`
+* GLSL: glslang
* Go: `gofmt`, `go vet`, `golint`, `gometalinter`!!, `go build`!!, `gosimple`, `staticcheck`
* GraphQL: `gqlint`
* Haml: `haml-lint`