diff --git a/contributing/development/configuring_an_ide/index.rst b/contributing/development/configuring_an_ide/index.rst index 4c03e6d77..32bb8bb9b 100644 --- a/contributing/development/configuring_an_ide/index.rst +++ b/contributing/development/configuring_an_ide/index.rst @@ -24,3 +24,15 @@ Development Environment), here are setup instructions for some popular ones: xcode It is possible to use other IDEs, but their setup is not documented yet. + +If your editor supports the `language server protocol `__, +you can use `clangd `__ for completion, diagnostics, and more. +You can generate a compilation database for use with clangd one of two ways: + +.. code-block:: shell + + # Generate compile_commands.json while compiling + scons compiledb=yes + + # Generate compile_commands.json without compiling + scons compiledb=yes compile_commands.json