diff options
| author | Joao Marcos Costa <jmcosta944@gmail.com> | 2023-10-01 12:00:35 +0200 |
|---|---|---|
| committer | Tom Rini <trini@konsulko.com> | 2023-10-11 13:24:55 -0400 |
| commit | 33717dbb20e00b5fa1791d9dfae3ffd6b528af86 (patch) | |
| tree | 72e83b7c9f6df75bdd2f7ab4879a98571b0d3f22 | |
| parent | 3a83960b76700db4aed576620a7cc15eea861c0e (diff) | |
| download | u-boot-33717dbb20e00b5fa1791d9dfae3ffd6b528af86.tar.gz u-boot-33717dbb20e00b5fa1791d9dfae3ffd6b528af86.tar.bz2 u-boot-33717dbb20e00b5fa1791d9dfae3ffd6b528af86.zip | |
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>
| -rw-r--r-- | doc/develop/ide_integration.rst | 12 | ||||
| -rw-r--r-- | doc/develop/index.rst | 1 |
2 files changed, 13 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`. diff --git a/doc/develop/index.rst b/doc/develop/index.rst index 003cdfccf1..f82e148b10 100644 --- a/doc/develop/index.rst +++ b/doc/develop/index.rst @@ -19,6 +19,7 @@ General security sending_patches system_configuration + ide_integration Implementation -------------- |