From b4a5a47499d5bf0cfe9c1fa137b96845de08450c Mon Sep 17 00:00:00 2001
From: Adrien 'neox' Bourmault <neox@gnu.org>
Date: Thu, 5 Dec 2024 21:22:11 +0100
Subject: [PATCH] packages: roms: release: include debug images in the release

This commit includes debugging images (with UART console) from bin-dbg in the
release, for instance in the roms-dbg directory. Tar files contain the string
"debug" to avoid people installing a debug image by accident, which can be a
problem as it can cause longer boot times. We also include a README explaining
what are the debugging settings.

Signed-off-by: Adrien 'neox' Bourmault <neox@gnu.org>
GNUtoo: created the README
Acked-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
---
 resources/packages/roms/release | 39 +++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/resources/packages/roms/release b/resources/packages/roms/release
index 376784a..c49051a 100755
--- a/resources/packages/roms/release
+++ b/resources/packages/roms/release
@@ -5,6 +5,7 @@
 #
 #    Copyright (C) 2020,2021 Leah Rowe <info@minifree.org>
 #    Copyright (C) 2023,2024 Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
+#    Copyright (C) 2024 Adrien Bourmault <neox@gnu.org>
 #
 #    This program is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU General Public License as published by
@@ -47,6 +48,10 @@ fi
     rm -Rf "release/roms/"
 [ ! -d "release/roms/" ] && \
     mkdir -p "release/roms/"
+[ -d "release/roms-dbg/" ] && \
+    rm -Rf "release/roms-dbg/"
+[ ! -d "release/roms-dbg/" ] && \
+    mkdir -p "release/roms-dbg/"
 
 printf "Building ROM image archives for version %s\n" "${version}"
 
@@ -80,3 +85,37 @@ printf "Building ROM image archives for version %s\n" "${version}"
 )
 
 printf "\nROM image release archives available at release/roms/\n\n"
+
+printf "Building ROM debug image archives for version %s\n" "${version}"
+
+(
+    # For consistency reasons, the same logic than above (look for a comment
+    # with "For consistency reasons" above). Though note that at the time of
+    # writing, there are no test yet for debug images.
+    cd bin-dbg/
+    for target in *; do
+        if [ ! -d "${target}/" ]; then
+            continue
+        fi
+
+        printf "Generating release/roms-dbg/%s-%s_debug_%s.tar.xz\n" \
+               "${projectname}" "${version}" "${target##*/}"
+        printf "%s\n" "${version}" > "${target}/version"
+        printf "%s\n" "${versiondate}" > "${target}/versiondate"
+        printf "%s\n" "${projectname}" > "${target}/projectname"
+        rm -f ../release/roms-dbg/"${projectname}"-"${version}"_debug_"${target##*/}".tar
+
+        tar -cf \
+            ../release/roms-dbg/"${projectname}"-"${version}"_debug_"${target##*/}".tar \
+            "${target}"/*.rom \
+            "${target}"/version \
+            "${target}"/versiondate \
+            "${target}"/projectname \
+            ../resources/coreboot/README.debug
+
+        xz -vv -9e -f \
+           ../release/roms-dbg/"${projectname}"-"${version}"_debug_"${target##*/}".tar
+    done
+)
+
+printf "Building debug ROM image archives for version %s\n" "${version}"
\ No newline at end of file