#3299 Merge gcc and clang into a cc linter

Users can easily be confused when they set some options for a C or C++
compiler, and another compiler is run with different options, which
still reports errors. To remedy this, the existing `gcc` and `clang`
linters have been replaced with a `cc` linter that will run either
compiler.

This is a breaking change for ALE v3.0.0.

1 files changed, 57 insertions, 68 deletions

diff --git a/doc/ale-cpp.txt b/doc/ale-cpp.txt
index fbe31370..651b4160 100644
--- a/doc/ale-cpp.txt
+++ b/doc/ale-cpp.txt
@@ -1,6 +1,9 @@
 ===============================================================================
 ALE C++ Integration                                           *ale-cpp-options*
 
+For basic checking of problems with C++ files, ALE offers the `cc` linter,
+which runs either `clang++`, or `gcc`. See |ale-cpp-cc|.
+
 
 ===============================================================================
 Global Options
@@ -38,41 +41,58 @@ g:ale_cpp_astyle_project_options             *g:ale_cpp_astyle_project_options*
 
 
 ===============================================================================
-clang                                                           *ale-cpp-clang*
+cc                                                                 *ale-cpp-cc*
+                                                                  *ale-cpp-gcc*
+                                                                *ale-cpp-clang*
 
-g:ale_cpp_clang_executable                         *g:ale_cpp_clang_executable*
-                                                   *b:ale_cpp_clang_executable*
+g:ale_cpp_cc_executable                               *g:ale_cpp_cc_executable*
+                                                      *b:ale_cpp_cc_executable*
   Type: |String|
-  Default: `'clang++'`
+  Default: `'<auto>'`
+
+  This variable can be changed to use a different executable for a C++ compiler.
 
-  This variable can be changed to use a different executable for clang.
+  ALE will try to use `clang++` if Clang is available, otherwise ALE will
+  default to checking C++ code with `gcc`.
 
 
-g:ale_cpp_clang_options                               *g:ale_cpp_clang_options*
-                                                      *b:ale_cpp_clang_options*
+g:ale_cpp_cc_options                                     *g:ale_cpp_cc_options*
+                                                         *b:ale_cpp_cc_options*
   Type: |String|
   Default: `'-std=c++14 -Wall'`
 
-  This variable can be changed to modify flags given to clang.
+  This variable can be change to modify flags given to the C++ compiler.
 
 
 ===============================================================================
-clangd                                                         *ale-cpp-clangd*
+ccls                                                             *ale-cpp-ccls*
 
-g:ale_cpp_clangd_executable                       *g:ale_cpp_clangd_executable*
-                                                  *b:ale_cpp_clangd_executable*
+g:ale_cpp_ccls_executable                           *g:ale_cpp_ccls_executable*
+                                                    *b:ale_cpp_ccls_executable*
   Type: |String|
-  Default: `'clangd'`
+  Default: `'ccls'`
 
-  This variable can be changed to use a different executable for clangd.
+  This variable can be changed to use a different executable for ccls.
 
 
-g:ale_cpp_clangd_options                             *g:ale_cpp_clangd_options*
-                                                     *b:ale_cpp_clangd_options*
-  Type: |String|
-  Default: `''`
+g:ale_cpp_ccls_init_options                       *g:ale_cpp_ccls_init_options*
+                                                  *b:ale_cpp_ccls_init_options*
+  Type: |Dictionary|
+  Default: `{}`
 
-  This variable can be changed to modify flags given to clangd.
+  This variable can be changed to customize ccls initialization options.
+  Example: >
+      {
+    \   'cacheDirectory': '/tmp/ccls',
+    \   'cacheFormat': 'binary',
+    \   'diagnostics': {
+    \     'onOpen': 0,
+    \     'opChange': 1000,
+    \   },
+    \ }
+<
+  Visit https://github.com/MaskRay/ccls/wiki/Initialization-options for all
+  available options and explanations.
 
 
 ===============================================================================
@@ -107,6 +127,25 @@ g:ale_cpp_clangcheck_options                     *g:ale_cpp_clangcheck_options*
 
 
 ===============================================================================
+clangd                                                         *ale-cpp-clangd*
+
+g:ale_cpp_clangd_executable                       *g:ale_cpp_clangd_executable*
+                                                  *b:ale_cpp_clangd_executable*
+  Type: |String|
+  Default: `'clangd'`
+
+  This variable can be changed to use a different executable for clangd.
+
+
+g:ale_cpp_clangd_options                             *g:ale_cpp_clangd_options*
+                                                     *b:ale_cpp_clangd_options*
+  Type: |String|
+  Default: `''`
+
+  This variable can be changed to modify flags given to clangd.
+
+
+===============================================================================
 clang-format                                              *ale-cpp-clangformat*
 
 See |ale-c-clangformat| for information about the available options.
@@ -296,60 +335,10 @@ g:ale_cpp_flawfinder_options                             *g:ale-cpp-flawfinder*
 
 
 ===============================================================================
-gcc                                                               *ale-cpp-gcc*
-
-g:ale_cpp_gcc_executable                             *g:ale_cpp_gcc_executable*
-                                                     *b:ale_cpp_gcc_executable*
-  Type: |String|
-  Default: `'gcc'`
-
-  This variable can be changed to use a different executable for gcc.
-
-
-g:ale_cpp_gcc_options                                   *g:ale_cpp_gcc_options*
-                                                        *b:ale_cpp_gcc_options*
-  Type: |String|
-  Default: `'-std=c++14 -Wall'`
-
-  This variable can be changed to modify flags given to gcc.
-
-
-===============================================================================
 uncrustify                                                 *ale-cpp-uncrustify*
 
 See |ale-c-uncrustify| for information about the available options.
 
 
 ===============================================================================
-ccls                                                             *ale-cpp-ccls*
-
-g:ale_cpp_ccls_executable                           *g:ale_cpp_ccls_executable*
-                                                    *b:ale_cpp_ccls_executable*
-  Type: |String|
-  Default: `'ccls'`
-
-  This variable can be changed to use a different executable for ccls.
-
-
-g:ale_cpp_ccls_init_options                       *g:ale_cpp_ccls_init_options*
-                                                  *b:ale_cpp_ccls_init_options*
-  Type: |Dictionary|
-  Default: `{}`
-
-  This variable can be changed to customize ccls initialization options.
-  Example: >
-      {
-    \   'cacheDirectory': '/tmp/ccls',
-    \   'cacheFormat': 'binary',
-    \   'diagnostics': {
-    \     'onOpen': 0,
-    \     'opChange': 1000,
-    \   },
-    \ }
-<
-  Visit https://github.com/MaskRay/ccls/wiki/Initialization-options for all
-  available options and explanations.
-
-
-===============================================================================
   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: