summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Roth <gaumless@gmail.com>2024-07-12 18:10:54 -0600
committerFelix Held <felix-coreboot@felixheld.de>2024-08-28 17:14:28 +0000
commitced2a017f2362af37d27126ef65b8894377df4d8 (patch)
treec0e18df7c9285bb37d21fc93445848c548192bd2
parentd15c1035b9ebbdf974c244d8df6e71ed8b86f0df (diff)
util/scripts: Add script to capture commands from build
This allows better debugging of the build by writing all the commands run by the build into a file by replacing the standard shell. Run with: make SHELL="${PWD}/util/scripts/capture_commands.sh" This will allow us to verify that the commands being run are posix compliant. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: I67efc5096747c2e746642639f88273132e070e49 Reviewed-on: https://review.coreboot.org/c/coreboot/+/83442 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Reviewed-by: Matt DeVillier <matt.devillier@gmail.com>
-rwxr-xr-xutil/scripts/capture_commands.sh17
-rw-r--r--util/scripts/description.md2
2 files changed, 19 insertions, 0 deletions
diff --git a/util/scripts/capture_commands.sh b/util/scripts/capture_commands.sh
new file mode 100755
index 0000000000..9e2e08f96b
--- /dev/null
+++ b/util/scripts/capture_commands.sh
@@ -0,0 +1,17 @@
+#!/usr/bin/env sh
+## SPDX-License-Identifier: BSD-3-Clause
+
+# This script allows us to capture all the commands run in the shell by the
+# coreboot build. This is better than using 'make v=1' because it captures
+# commands right from the beginning of the build, and sends the output of any
+# command to the interactive shell.
+
+# To use, run:
+# make SHELL="${PWD}/util/scripts/capture_commands.sh"
+
+REALSHELL=${REALSHELL:-sh}
+OUTPUT_DIR=${TOP:-/tmp}
+CAPTURE_FILE=${CAPTURE_FILE:-commands.txt}
+
+env echo "$*" | sed 's/^-c '// >> "${OUTPUT_DIR}/${CAPTURE_FILE}"
+"${REALSHELL}" "$@"
diff --git a/util/scripts/description.md b/util/scripts/description.md
index 1c67f07399..91a108cfaf 100644
--- a/util/scripts/description.md
+++ b/util/scripts/description.md
@@ -1,4 +1,6 @@
__scripts__
+ * capture_commands.sh - Write all commands from the build to a file.
+ `Shell`
* _config_ - Manipulate options in a .config file from the command
line `Bash`
* _cross-repo-cherrypick_ - Pull in patches from another tree from a