summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPeter Renström <renstrom.peter@gmail.com>2017-08-24 23:49:43 +0200
committerw0rp <w0rp@users.noreply.github.com>2017-08-24 22:49:43 +0100
commit4bea50b82f53a351d218cc3af120b460b9d1639f (patch)
treec14ac460c270d0415fea5fa6ec2988ee4cbbf76e /doc
parent623fdf212cd70131df4d3c52de26d9d1faa5d90e (diff)
downloadale-4bea50b82f53a351d218cc3af120b460b9d1639f.zip
Add clang-format fixer for C/C++ (#873)
* Add clang-format fixer for C/C++ * Document clang-format options * Refer ale-cpp-clangformat to ale-c-clangformat
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-c.txt19
-rw-r--r--doc/ale-cpp.txt7
-rw-r--r--doc/ale.txt6
3 files changed, 30 insertions, 2 deletions
diff --git a/doc/ale-c.txt b/doc/ale-c.txt
index 2572d885..1e1322bc 100644
--- a/doc/ale-c.txt
+++ b/doc/ale-c.txt
@@ -60,4 +60,23 @@ g:ale_c_gcc_options *g:ale_c_gcc_options*
===============================================================================
+clang-format *ale-c-clangformat*
+
+g:ale_c_clangformat_executable *g:ale_c_clangformat_executable*
+ *b:ale_c_clangformat_executable*
+ Type: |String|
+ Default: `'clang-format'`
+
+ This variable can be changed to use a different executable for clang-format.
+
+
+g:ale_c_clangformat_options *g:ale_c_clangformat_options*
+ *b:ale_c_clangformat_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be change to modify flags given to clang-format.
+
+
+===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-cpp.txt b/doc/ale-cpp.txt
index 854e9b4e..2ece6843 100644
--- a/doc/ale-cpp.txt
+++ b/doc/ale-cpp.txt
@@ -190,4 +190,11 @@ g:ale_cpp_gcc_options *g:ale_cpp_gcc_options*
===============================================================================
+clang-format *ale-cpp-clangformat*
+
+See |ale-c-clangformat| for information about the available options.
+Note that the C options are also used for C++.
+
+
+===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale.txt b/doc/ale.txt
index 18ea367c..56c5946e 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -19,6 +19,7 @@ CONTENTS *ale-contents*
clang...............................|ale-c-clang|
cppcheck............................|ale-c-cppcheck|
gcc.................................|ale-c-gcc|
+ clang-format........................|ale-c-clangformat|
chef..................................|ale-chef-options|
foodcritic..........................|ale-chef-foodcritic|
cpp...................................|ale-cpp-options|
@@ -28,6 +29,7 @@ CONTENTS *ale-contents*
cppcheck............................|ale-cpp-cppcheck|
cpplint.............................|ale-cpp-cpplint|
gcc.................................|ale-cpp-gcc|
+ clang-format........................|ale-cpp-clangformat|
css...................................|ale-css-options|
stylelint...........................|ale-css-stylelint|
cmake.................................|ale-cmake-options|
@@ -176,8 +178,8 @@ The following languages and tools are supported.
* Asciidoc: 'proselint'
* Bash: 'shell' (-n flag), 'shellcheck'
* Bourne Shell: 'shell' (-n flag), 'shellcheck'
-* C: 'cppcheck', 'gcc', 'clang'
-* C++ (filetype cpp): 'clang', 'clangtidy', 'cppcheck', 'cpplint', 'gcc'
+* C: 'cppcheck', 'gcc', 'clang', 'clang-format'
+* C++ (filetype cpp): 'clang', 'clangtidy', 'cppcheck', 'cpplint', 'gcc', 'clang-format'
* C#: 'mcs'
* Chef: 'foodcritic'
* CMake: 'cmakelint'