From e3e5f2bbaf058ace76bcf78669a7531e2232ae24 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Beno=C3=AEt=20Dufour?= <benoit.dufour@mail.com>
Date: Wed, 14 Aug 2024 18:48:28 -0400
Subject: [PATCH] app-shells/shox: Add explanation about why EGO_SUM is used by
 this ebuild instead of the bundled vendor.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Benoît Dufour <benoit.dufour@mail.com>
---
 app-shells/shox/shox-2024.01.25.ebuild | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/app-shells/shox/shox-2024.01.25.ebuild b/app-shells/shox/shox-2024.01.25.ebuild
index 30f1942b28..163b421165 100644
--- a/app-shells/shox/shox-2024.01.25.ebuild
+++ b/app-shells/shox/shox-2024.01.25.ebuild
@@ -98,14 +98,18 @@ src_prepare() {
 
 	rm -rf ./vendor
 
+    # shox fails to build when the go version in its go.mod is go 1.15. It needs to be at least 1.17.
 	sed -ie "s/go 1.15/go 1.17/" ./go.mod || die "Fails applying go version patch."
 }
 
 src_compile() {
-	#ego build -mod=vendor ./cmd/shox
+    # If the current EGO_SUM is removed, this command will fail complaining about inconsitency.
+    # It will then ask for running "ego mod vendor", which will also fail because it will try downloading dependencies.
 	ego mod tidy
+    # This command succeeds with EGO_SUM but will fail without it.
 	ego build ./cmd/shox
-	#ego build
+    # If the current EGO_SUM is removed, this command will fail.
+	#ego build -mod=vendor ./cmd/shox
 }
 
 src_test() {