aboutsummaryrefslogtreecommitdiff
path: root/scripts
diff options
context:
space:
mode:
authorJoao Marcos Costa2023-10-01 12:00:34 +0200
committerTom Rini2023-10-11 13:24:55 -0400
commit3a83960b76700db4aed576620a7cc15eea861c0e (patch)
treed130da4b1ade084bb3ba0347528575748acd9a7a /scripts
parentb703bda0bee82288793b9b8e7376b7826c58ce80 (diff)
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>
Diffstat (limited to 'scripts')
-rwxr-xr-xscripts/gen_compile_commands.py1
1 files changed, 1 insertions, 0 deletions
diff --git a/scripts/gen_compile_commands.py b/scripts/gen_compile_commands.py
index 1a9c49b34a2..aa52e88e18f 100755
--- a/scripts/gen_compile_commands.py
+++ b/scripts/gen_compile_commands.py
@@ -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."""