Djam/u-boot
1
0
Fork 0
mirror of https://github.com/u-boot/u-boot.git synced 2025-04-18 02:44:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: add ide_integration.rst to doc/develop

Browse source 
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>
This commit is contained in:
Joao Marcos Costa 2023-10-01 12:00:35 +02:00 • committed by Tom Rini
parent 3a83960b76
commit 33717dbb20
2 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/develop/ide_integration.rst Normal file
View file

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

1
doc/develop/index.rst
View file

@ -19,6 +19,7 @@ General
security
sending_patches
system_configuration
ide_integration
Implementation
--------------