From 30a07094a6ebdc03e23db2a33b2e24f25da55869 Mon Sep 17 00:00:00 2001
From: Guillaume Gomez <guillaume.gomez@huawei.com>
Date: Thu, 2 Nov 2023 14:14:34 +0100
Subject: [PATCH] Add comment explaining why the ENABLE_GCC_CODEGEN env
 variable is needed

---
 src/ci/docker/host-x86_64/x86_64-gnu-llvm-15/script.sh | 4 ++++
 src/ci/run.sh                                          | 6 ++++--
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/src/ci/docker/host-x86_64/x86_64-gnu-llvm-15/script.sh b/src/ci/docker/host-x86_64/x86_64-gnu-llvm-15/script.sh
index b964f19fe0bac..2eb751ca3766d 100755
--- a/src/ci/docker/host-x86_64/x86_64-gnu-llvm-15/script.sh
+++ b/src/ci/docker/host-x86_64/x86_64-gnu-llvm-15/script.sh
@@ -4,6 +4,8 @@ set -ex
 
 # Only run the stage 1 tests on merges, not on PR CI jobs.
 if [[ -z "${PR_CI_JOB}" ]]; then
+    # When running gcc backend tests, we need to install `libgccjit` and to not run llvm codegen
+    # tests as it will fail them.
     if [[ "${ENABLE_GCC_CODEGEN}" == "1" ]]; then
         ../x.py --stage 1 test --skip src/tools/tidy --skip tests/codegen
     else
@@ -23,6 +25,8 @@ if [[ -z "${PR_CI_JOB}" ]]; then
     ../x.py --stage 1 test tests/ui-fulldeps
 fi
 
+# When running gcc backend tests, we need to install `libgccjit` and to not run llvm codegen
+# tests as it will fail them.
 # NOTE: intentionally uses all of `x.py`, `x`, and `x.ps1` to make sure they all work on Linux.
 if [[ "${ENABLE_GCC_CODEGEN}" == "1" ]]; then
     ../x.py --stage 2 test --skip src/tools/tidy --skip tests/codegen
diff --git a/src/ci/run.sh b/src/ci/run.sh
index 70956c63db59b..31ef55216b91c 100755
--- a/src/ci/run.sh
+++ b/src/ci/run.sh
@@ -126,11 +126,13 @@ else
 
   RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --set rust.verify-llvm-ir"
 
+  # When running gcc backend tests, we need to install `libgccjit` and to not run llvm codegen
+  # tests as it will fail them.
   if [[ "${ENABLE_GCC_CODEGEN}" == "1" ]]; then
-    # Test the Cranelift backend in CI. Bootstrap knows which targets to run tests on.
+    # Test the Cranelift and GCC backends in CI. Bootstrap knows which targets to run tests on.
     RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --set rust.codegen-backends=llvm,cranelift,gcc"
   else
-    # Test the Cranelift and GCC backends in CI. Bootstrap knows which targets to run tests on.
+    # Test the Cranelift backend in CI. Bootstrap knows which targets to run tests on.
     RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --set rust.codegen-backends=llvm,cranelift"
   fi