diff options
| author | Tom Rini <trini@konsulko.com> | 2023-10-11 13:25:01 -0400 |
|---|---|---|
| committer | Tom Rini <trini@konsulko.com> | 2023-10-11 13:25:01 -0400 |
| commit | 997bef3c6d22d12c7fd092fb831bf94d114c9f6f (patch) | |
| tree | a954cb460dce820a864e05a41380b84056718b75 /doc/develop/ide_integration.rst | |
| parent | 6e0a75d3162a024cb0cdedd871d435e6ee782447 (diff) | |
| parent | 311df90b3eab4dcf4124e360214b8535401c7d39 (diff) | |
Merge branch '2023-10-11-port-gen_compile_commands_py'
To quote the author:
I'm submitting a patch series that ports the gen_compile_commands.py
script from the Linux kernel's sources to U-Boot. This script,
originally located in scripts/clang-tools/gen_compile_commands.py,
enables the generation of compile_commands.json file for improved code
navigation and analysis. The series consists of the initial script
import, the necessary modifications for U-Boot compatibility, and
finally some documentation.
Diffstat (limited to 'doc/develop/ide_integration.rst')
| -rw-r--r-- | doc/develop/ide_integration.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/develop/ide_integration.rst b/doc/develop/ide_integration.rst new file mode 100644 index 0000000000..455e09959c --- /dev/null +++ b/doc/develop/ide_integration.rst @@ -0,0 +1,12 @@ +Integration with IDEs +===================== + +IDEs and text editors (e.g., VSCode, Emacs, Vim, Neovim) typically offer +plugins to enhance the development experience, such as Clangd LSP. These +plugins provide features like code navigation (i.e., jumping to definitions +and declarations), code completion, and code formatting. + +U-Boot provides a script (i.e., scripts/gen_compile_commands.py) that +generates a compilation database to be utilized by Clangd LSP for code +navigation. For detailed usage instructions, please refer to the script's +documentation: :doc:`../build/gen_compile_commands`. |