u-boot/doc/develop/ide_integration.rst
Joao Marcos Costa 33717dbb20 doc: add ide_integration.rst to doc/develop
Add 'Integration with IDEs' chapter.

For now, this chapter is mostly a reference to the documentation of
gen_compile_commands, in doc/build, but it can be futurely used as
a guide for other IDE-friendly features.

Signed-off-by: Joao Marcos Costa <jmcosta944@gmail.com>
Tested-by: Joao Paulo Goncalves <joao.goncalves@toradex.com>
2023-10-11 13:24:55 -04:00

12 lines
593 B
ReStructuredText

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`.