colin/u-boot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: add documentation for gen_compile_commands.py

Browse Source 
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>
This commit is contained in:
Joao Marcos Costa
2023-10-01 12:00:34 +02:00
committed by Tom Rini
parent b703bda0be
commit 3a83960b76
3 changed files with 85 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
scripts/gen_compile_commands.py
View File

@@ -5,6 +5,7 @@
#
# Author: Tom Roeder <tmroeder@google.com>
# Ported and modified for U-Boot by Joao Marcos Costa <jmcosta944@gmail.com>
# Briefly documented at doc/build/gen_compile_commands.rst
#
"""A tool for generating compile_commands.json in U-Boot."""