From 52de68e85d9fa9b264346e88f84f50dd4b3691e3 Mon Sep 17 00:00:00 2001
From: Fabian Meumertzheim <fabian@meumertzhe.im>
Date: Mon, 4 Dec 2023 15:08:37 +0100
Subject: [PATCH] Address review comment

---
 .../com/google/devtools/build/lib/packages/Package.java  | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/main/java/com/google/devtools/build/lib/packages/Package.java b/src/main/java/com/google/devtools/build/lib/packages/Package.java
index d2651f70d9c29f..a8f658ff4bc141 100644
--- a/src/main/java/com/google/devtools/build/lib/packages/Package.java
+++ b/src/main/java/com/google/devtools/build/lib/packages/Package.java
@@ -1001,6 +1001,15 @@ default boolean precomputeTransitiveLoads() {
 
     private final List<TargetPattern> registeredExecutionPlatforms = new ArrayList<>();
     private final List<TargetPattern> registeredToolchains = new ArrayList<>();
+
+    /**
+     * Tracks the index within {@link #registeredToolchains} of the first toolchain registered from
+     * the WORKSPACE suffixes rather than the WORKSPACE file (if any).
+     *
+     * <p>This is needed to distinguish between these toolchains during resolution: toolchains
+     * registered in WORKSPACE have precedence over those defined in non-root Bazel modules,
+     * which in turn have precedence over those from the WORKSPACE suffixes.</p>
+     */
     private OptionalInt firstWorkspaceSuffixRegisteredToolchain = OptionalInt.empty();
 
     /**