diff options
| author | w0rp <devw0rp@gmail.com> | 2017-07-16 21:37:10 +0100 |
|---|---|---|
| committer | w0rp <devw0rp@gmail.com> | 2017-07-16 21:37:10 +0100 |
| commit | 54ff57317455994305b8bba085c5db166dc34373 (patch) | |
| tree | 9db086a17ce56e81aab3f6099cdeedbe9350f540 /doc | |
| parent | bd5ff5b1e52723c910f083bb4b37bad6a410900d (diff) | |
| download | ale-54ff57317455994305b8bba085c5db166dc34373.zip | |
#711 - Make the clang executables configurable
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-c.txt | 10 | ||||
| -rw-r--r-- | doc/ale-cpp.txt | 14 |
2 files changed, 20 insertions, 4 deletions
diff --git a/doc/ale-c.txt b/doc/ale-c.txt index 54b118f2..57d544db 100644 --- a/doc/ale-c.txt +++ b/doc/ale-c.txt @@ -5,12 +5,20 @@ ALE C Integration *ale-c-options* =============================================================================== clang *ale-c-clang* +g:ale_c_clang_executable *g:ale_c_clang_executable* + *b:ale_c_clang_executable* + Type: |String| + Default: `'clang'` + + This variable can be changed to use a different executable for clang. + + g:ale_c_clang_options *g:ale_c_clang_options* *b:ale_c_clang_options* Type: |String| Default: `'-std=c11 -Wall'` - This variable can be change to modify flags given to clang. + This variable can be changed to modify flags given to clang. =============================================================================== diff --git a/doc/ale-cpp.txt b/doc/ale-cpp.txt index 9b745b2a..3e8ce9e1 100644 --- a/doc/ale-cpp.txt +++ b/doc/ale-cpp.txt @@ -36,6 +36,14 @@ g:ale_c_build_dir *g:ale_c_build_dir* =============================================================================== clang *ale-cpp-clang* +g:ale_cpp_clang_executable *g:ale_cpp_clang_executable* + *b:ale_cpp_clang_executable* + Type: |String| + Default: `'clang++'` + + This variable can be changed to use a different executable for clang. + + g:ale_cpp_clang_options *g:ale_cpp_clang_options* *b:ale_cpp_clang_options* Type: |String| @@ -45,7 +53,7 @@ g:ale_cpp_clang_options *g:ale_cpp_clang_options* =============================================================================== -clangcheck *ale-cpp-clangcheck* +clangcheck *ale-cpp-clangcheck* `clang-check` will be run only when files are saved to disk, so that `compile_commands.json` files can be used. It is recommended to use this @@ -55,8 +63,8 @@ Therefore, `clang-check` linter reads the options |g:ale_c_build_dir| and overrides |g:ale_c_build_dir_names|. -g:ale_cpp_clangcheck_options *g:ale_cpp_clangcheck_options* - *b:ale_cpp_clangcheck_options* +g:ale_cpp_clangcheck_options *g:ale_cpp_clangcheck_options* + *b:ale_cpp_clangcheck_options* Type: |String| Default: `''` |