diff mbox series

[v4,7/8] doc: add ide_integration.rst to doc/develop

Message ID 20231001100036.34936-8-jmcosta944@gmail.com
State Accepted
Commit 33717dbb20e00b5fa1791d9dfae3ffd6b528af86
Delegated to: Tom Rini
Headers show
Series Port gen_compile_commands.py from Linux to U-Boot | expand

Commit Message

João Marcos Costa Oct. 1, 2023, 10 a.m. UTC 
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>
---
 doc/develop/ide_integration.rst | 12 ++++++++++++
 doc/develop/index.rst           |  1 +
 2 files changed, 13 insertions(+)
 create mode 100644 doc/develop/ide_integration.rst
diff mbox series

Patch

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 5b230d0321..272bdef84d 100644
--- a/doc/develop/index.rst
+++ b/doc/develop/index.rst
@@ -19,6 +19,7 @@  General
    security
    sending_patches
    system_configuration
+   ide_integration
 
 Implementation
 --------------