Add code comment about GHCup.Platform.getStackGhcBuilds and notification

commercialhaskell · Jan 1, 2025 · 9f1ba4e · 9f1ba4e
1 parent 8064dda
commit 9f1ba4e
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/Stack/Setup.hs b/src/Stack/Setup.hs
@@ -1694,6 +1694,10 @@ getGhcBuilds = do
     Just ghcBuild -> pure [ghcBuild]
     Nothing -> determineGhcBuild
  where
+  -- The GHCup project is also interested in the algorithm below, as it copies
+  -- it at GHCup.Platform.getStackGhcBuilds. If you change this algorithm, it
+  -- would be a courtesy to bring that to the attention of the GHCup project
+  -- maintainers.
   determineGhcBuild = do
     -- TODO: a more reliable, flexible, and data driven approach would be to
     -- actually download small "test" executables (from setup-info) that link to