From f6b0a45a1d296f3c32b0ace209c7bdb4361f04fb Mon Sep 17 00:00:00 2001
From: Simon Jakobi <simon.jakobi@gmail.com>
Date: Sun, 14 Nov 2021 15:25:28 +0000
Subject: [PATCH] README: Add comment regarding use of `:override` in
 `active-repositories`

Skipping the `:override` makes sense for example when compatibility patches have been released in new versions on hackage.haskell.org.
---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index 5459be29..21217a51 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,13 @@ repository head.hackage.ghc.haskell.org
        26021a13b401500c8eb2761ca95c61f2d625bfef951b939a8124ed12ecf07329
        7541f32a4ccca4f97aea3b22f5e593ba2c0267546016b992dfadcd2fe944e55d
 
+-- To allow cabal to consider using alternative versions of packages that
+-- are patched in head.hackage, skip the `:override`:
+--
+-- active-repositories: hackage.haskell.org, head.hackage.ghc.haskell.org
+--
+-- See
+-- https://cabal.readthedocs.io/en/latest/cabal-project.html#cfg-field-active-repositories
 active-repositories: hackage.haskell.org, head.hackage.ghc.haskell.org:override
 ```
 
-- 
GitLab