summaryrefslogtreecommitdiff
path: root/doc/ale-c.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ale-c.txt')
-rw-r--r--doc/ale-c.txt39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/ale-c.txt b/doc/ale-c.txt
new file mode 100644
index 00000000..08f4abac
--- /dev/null
+++ b/doc/ale-c.txt
@@ -0,0 +1,39 @@
+===============================================================================
+ALE C Integration *ale-c-options*
+
+
+-------------------------------------------------------------------------------
+clang *ale-c-clang*
+
+g:ale_c_clang_options *g:ale_c_clang_options*
+
+ Type: |String|
+ Default: `'-std=c11 -Wall'`
+
+ This variable can be change to modify flags given to clang.
+
+
+-------------------------------------------------------------------------------
+cppcheck *ale-c-cppcheck*
+
+g:ale_c_cppcheck_options *g:ale_c_cppcheck_options*
+
+ Type: |String|
+ Default: `'--enable=style'`
+
+ This variable can be changed to modify flags given to cppcheck.
+
+
+-------------------------------------------------------------------------------
+gcc *ale-c-gcc*
+
+g:ale_c_gcc_options *g:ale_c_gcc_options*
+
+ Type: |String|
+ Default: `'-std=c11 -Wall'`
+
+ This variable can be change to modify flags given to gcc.
+
+
+-------------------------------------------------------------------------------
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: