Merge pull request #528 from mjlbach/improve_ccls_documentation

ccls: Improve documentation, add on_init example

1 files changed, 19 insertions, 0 deletions

diff --git a/lua/lspconfig/ccls.lua b/lua/lspconfig/ccls.lua
index d167249d..20415d28 100644
--- a/lua/lspconfig/ccls.lua
+++ b/lua/lspconfig/ccls.lua
@@ -15,6 +15,25 @@ https://github.com/MaskRay/ccls/wiki
 ccls relies on a [JSON compilation database](https://clang.llvm.org/docs/JSONCompilationDatabase.html) specified
 as compile_commands.json or, for simpler projects, a compile_flags.txt.
 For details on how to automatically generate one using CMake look [here](https://cmake.org/cmake/help/latest/variable/CMAKE_EXPORT_COMPILE_COMMANDS.html).
+
+Customization options are passed to ccls at initialization time via init_options, a list of available options can be found [here](https://github.com/MaskRay/ccls/wiki/Customization#initialization-options). For example:
+
+```lua
+local lspconfig = require'lspconfig'
+lspconfig.ccls.setup {
+  init_options = {
+	  compilationDatabaseDirectory = "build";
+    index = {
+      threads = 0;
+    };
+    clang = {
+      excludeArgs = { "-frounding-math"} ;
+    };
+  }
+}
+
+```
+
 ]];
     default_config = {
       root_dir = [[root_pattern("compile_commands.json", "compile_flags.txt", ".git")]];