[PATCH v4 0/8] Port gen_compile_commands.py from Linux to U-Boot

Joao Marcos Costa jmcosta944 at gmail.com
Sun Oct 1 12:00:28 CEST 2023


Hello U-Boot community,

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.

Your feedback on these contributions would be greatly appreciated.

Best regards,

Changes in v4:
- Replace "Options" section in the doc by "Usage", as it is simply a reference
  to the script's usage message
- Replace 'kernel' by 'U-Boot' in the usage message
- Replace label by :doc: link
- Instead of adding a chapter about integration with IDEs into
  doc/build/tools.rst, add a new file (i.e., doc/develop/ide_integration.rst)
- Replace the doc's heading (gen_compile_commands) by 'Create build database for
  IDEs'
- Add a section listing some of the compatible IDEs and how to set them up
Changes in v3:
- Add documentation to index and fix syntax issues
- Add reference to documentation in doc/build/tools
Changes in v2:
- Add compile_commands.json to gitignore
- Add documentation

Joao Marcos Costa (8):
  scripts: Port Linux's gen_compile_commands.py to U-Boot
  scripts/gen_compile_commands.py: adapt _LINE_PATTERN
  scripts/gen_compile_commands.py: fix docstring
  scripts/gen_compile_commands.py: add acknowledgments
  .gitignore: add compile_commands.json
  doc: add documentation for gen_compile_commands.py
  doc: add ide_integration.rst to doc/develop
  scripts/gen_compile_commands: fix usage message

 .gitignore                         |   3 +
 doc/build/gen_compile_commands.rst |  84 +++++++++++
 doc/build/index.rst                |   1 +
 doc/develop/ide_integration.rst    |  13 ++
 doc/develop/index.rst              |   1 +
 scripts/gen_compile_commands.py    | 230 +++++++++++++++++++++++++++++
 6 files changed, 332 insertions(+)
 create mode 100644 doc/build/gen_compile_commands.rst
 create mode 100644 doc/develop/ide_integration.rst
 create mode 100755 scripts/gen_compile_commands.py

-- 
2.41.0



More information about the U-Boot mailing list