godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-03 05:48:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

Document compiledb generation.

Browse Source 
The compiledb=yes flag is only documented in the vscode and clion sections, but is relevant to any LSP-based editor.

In addition, nothing mentioned the ability to generate a compilation database without compiling, referenced here:

https://github.com/godotengine/godot/issues/39883#issuecomment-924423857
This commit is contained in:
Ryan Roden-Corrent
2023-03-04 07:25:34 -05:00
parent c01e3f4d8c
commit 009ca60f33
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
contributing/development/configuring_an_ide/index.rst
View File

@@ -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 <https://microsoft.github.io/language-server-protocol/>`__,
you can use `clangd <https://clangd.llvm.org>`__ 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