Add comments to overlays.

clash-lang · Sep 25, 2024 · 79ec207 · 79ec207
1 parent 4d8d944
commit 79ec207
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 5 deletions.
diff --git a/nix/overlay-ghc910.nix b/nix/overlay-ghc910.nix
@@ -8,18 +8,17 @@ in
   # is basically abandonware it catches fire with brick 1.0+.
   brick = doJailbreak prev.brick_0_70_1;
 
+  # brick 0.70.1 requires vty < 6.0.
   vty = doJailbreak (prev.callHackage "vty" "5.39" { });
 
+  # Relies on older versions of some libraries.
   hint = doJailbreak prev.hint;
 
-  th-desugar = prev.th-desugar_1_17;
-
-  singletons-th = prev.singletons-th_3_4;
-
   # Marked as broken in nixpkgs, since it specifies much older dependencies
   # than the defaults in nixpkgs.
   rewrite-inspector = doJailbreak (markUnbroken prev.rewrite-inspector);
 
+  # Requires some old versions of libraries, but still works.
   derive-storable-plugin = doJailbreak prev.derive-storable-plugin;
 
   # Marken as broken, but compiles anyway.
@@ -40,10 +39,15 @@ in
   # Relies on older versions of text.
   string-random = doJailbreak prev.string-random;
 
+  # We need the newest version from nixpkgs for these packages.
   singletons-base = prev.singletons-base_3_4;
 
   microstache = prev.microstache_1_0_3;
 
+  th-desugar = prev.th-desugar_1_17;
+
+  singletons-th = prev.singletons-th_3_4;
+
   # nixplgs doesn't include revision 1, changing dependency on template-haskell.
   string-interpolate = pkgs.haskell.lib.compose.overrideCabal (drv: {
     revision = "1";

diff --git a/nix/overlay-ghc96.nix b/nix/overlay-ghc96.nix
@@ -1,7 +1,7 @@
 { pkgs }:
 final: prev:
 let
-  inherit (pkgs.haskell.lib) doJailbreak dontCheck markUnbroken;
+  inherit (pkgs.haskell.lib) doJailbreak markUnbroken;
 in
 {
   # Use an older version than the default in nixpkgs. Since rewrite-inspector

diff --git a/nix/overlay-ghc98.nix b/nix/overlay-ghc98.nix
@@ -8,12 +8,14 @@ in
   # is basically abandonware it catches fire with brick 1.0+.
   brick = doJailbreak prev.brick_0_70_1;
 
+  # brick 0.70.1 requires vty < 6.0.
   vty = doJailbreak (prev.callHackage "vty" "5.39" { });
 
   # Marked as broken in nixpkgs, since it specifies much older dependencies
   # than the defaults in nixpkgs.
   rewrite-inspector = doJailbreak (markUnbroken prev.rewrite-inspector);
 
+  # Requires some old versions of libraries, but still works.
   derive-storable-plugin = doJailbreak prev.derive-storable-plugin;
 
   # Marken as broken, but compiles anyway.