]> git.ipfire.org Git - thirdparty/u-boot.git/commit - scripts/gen_compile_commands.py
doc: add documentation for gen_compile_commands.py
authorJoao Marcos Costa <jmcosta944@gmail.com>
Sun, 1 Oct 2023 10:00:34 +0000 (12:00 +0200)
committerTom Rini <trini@konsulko.com>
Wed, 11 Oct 2023 17:24:55 +0000 (13:24 -0400)
commit3a83960b76700db4aed576620a7cc15eea861c0e
treed130da4b1ade084bb3ba0347528575748acd9a7a
parentb703bda0bee82288793b9b8e7376b7826c58ce80
doc: add documentation for gen_compile_commands.py

This documentation briefly explains what is a compilation database,
and how to use the script to generate one.

This is not a portage, as there was no original documentation in the
Linux sources.

Acknowledge the documentation in the script's header and in doc/build
index.

Signed-off-by: Joao Marcos Costa <jmcosta944@gmail.com>
Tested-by: Joao Paulo Goncalves <joao.goncalves@toradex.com>
doc/build/gen_compile_commands.rst [new file with mode: 0644]
doc/build/index.rst
scripts/gen_compile_commands.py