Rename pkg-def-overlays to pkg-def-extras (#79)

* Rename pkg-def-overlays to pkg-def-extras

Fixes #75

Author: angerman

default.nix

@@ -55,7 +55,7 @@ let
     # and Nix expressions representing cabal packages (cabal-to-nix).
     mkPkgSet =
       { pkg-def  # Base package set. Either from stackage (via stack-to-nix) or from a cabal projects plan file (via plan-to-nix)
-      , pkg-def-overlays ? [] # Additional packages to augment the Base package set `pkg-def` with.
+      , pkg-def-extras ? [] # Additional packages to augment the Base package set `pkg-def` with.
       , modules ? []
       }@args:
 
@@ -67,35 +67,35 @@ let
     # Create a Haskell package set based on a Stack configuration.
     mkStackPkgSet =
       { stack-pkgs  # Path to the output of stack-to-nix
-      , pkg-def-overlays ? []
+      , pkg-def-extras ? []
       , modules ? []
       }@args:
 
       let
         # The Stackage release referenced in the stack config
         pkg-def = stackage.${stack-pkgs.resolver};
         # The compiler referenced in the stack config
-        compiler = (stack-pkgs.overlay hackage).compiler or (pkg-def hackage).compiler;
+        compiler = (stack-pkgs.extras hackage).compiler or (pkg-def hackage).compiler;
       in self.mkPkgSet {
         inherit pkg-def;
-        pkg-def-overlays = [ stack-pkgs.overlay ] ++ pkg-def-overlays;
+        pkg-def-extras = [ stack-pkgs.extras ] ++ pkg-def-extras;
         modules = [ ghcHackagePatches.${compiler.nix-name} ] ++ modules;
       };
 
     # Create a Haskell package set based on a Cabal configuration.
     mkCabalProjectPkgSet =
       { plan-pkgs  # Path to the output of plan-to-nix
-      , pkg-def-overlays ? []
+      , pkg-def-extras ? []
       , modules ? []
       }@args:
 
       let
         pkg-def = plan-pkgs.pkgs;
         # The compiler referenced in the stack config
-        compiler = (plan-pkgs.overlay hackage).compiler or (pkg-def hackage).compiler;
+        compiler = (plan-pkgs.extras hackage).compiler or (pkg-def hackage).compiler;
       in self.mkPkgSet {
         inherit pkg-def;
-        pkg-def-overlays = [ plan-pkgs.overlay ] ++ pkg-def-overlays;
+        pkg-def-extras = [ plan-pkgs.extras ] ++ pkg-def-extras;
         modules = [ ghcHackagePatches.${compiler.nix-name} ] ++ modules;
       };
 

docs/iohk-nix.md

@@ -41,7 +41,7 @@ iohk-nix.json
 nix/pkgs.nix
 ```
 { pkgs ? import <nixpkgs> {}
-, iohk-overlay ? {}
+, iohk-extras ? {}
 , iohk-module ? {}
 , haskell
 , hackage
@@ -67,16 +67,16 @@ let
   #  packages.cbors.patches = [ ./one.patch ];
   #  packages.cbors.flags.optimize-gmp = false;
   #
-  compiler = (stack-pkgs.overlay hackage).compiler.nix-name;
+  compiler = (stack-pkgs.extras hackage).compiler.nix-name;
   pkgSet = haskell.mkNewPkgSet {
     inherit pkgs;
     pkg-def = stackage.${stack-pkgs.resolver};
-    # The overlay allows extension or restriction of the set of
-    # packages we are interested in. By using the stack-pkgs.overlay
+    # These extras allow extension or restriction of the set of
+    # packages we are interested in. By using the stack-pkgs.extras
     # we restrict our package set to the ones provided in stack.yaml.
-    pkg-def-overlays = [
-      stack-pkgs.overlay
-      iohk-overlay.${compiler}
+    pkg-def-extras = [
+      stack-pkgs.extras
+      iohk-extras.${compiler}
     ];
     # package customizations
     modules = [

docs/user-guide-cabal.md

@@ -50,7 +50,7 @@ file as follows:
 ```nix
 let plan = import ./plan.nix; in
 { pkg-def = plan;
-  overlay =
+  extras =
     { local-package-a = ./local-package-a.nix;
       local-package-b = ./local-package-b.nix;
       source-import-a = ./source-import-a.nix;

docs/user-guide-stack.md

@@ -17,7 +17,7 @@ This will produce a `nix/pkgs.nix` file that looks like the following:
 ```nix
 {
   resolver = "lts-12.17";
-  overlay = hackage:
+  extras = hackage:
     {
       packages = {
         "o-clock" = hackage.o-clock."0.1.1".revisions.default;
@@ -30,9 +30,9 @@ This will produce a `nix/pkgs.nix` file that looks like the following:
 }
 ```
 
-This file contains the stackage resolver, as well as an overlay of
-packages.  The overlay specifies which `extra-deps` (here: o-clock-0.1.1)
-we wanted to overlay over the stackage snapshot, and what local
+This file contains the stackage resolver, as well as set of extra
+packages.  The extras specifies which `extra-deps` (here: o-clock-0.1.1)
+we wanted to add over the stackage snapshot, and what local
 packages we want (here: my-package).
 
 *If you came here from the [User Guide](/user-guide), go back and

docs/user-guide.md

@@ -86,12 +86,12 @@ let
   # Cabal projects use mkPkgSet
   pkgSet = haskell.mkPkgSet {
     pkg-def = my-pkgs.pkg-def;
-    pkg-def-overlays = [
-      # this overlay will provide additional packages
+    pkg-def-extras = [
+      # these extras will provide additional packages
       # ontop of the package set.  E.g. extra-deps
       # for stack packages. or local packages for
       # cabal.projects
-      my-pkgs.overlay
+      my-pkgs.extras
     ];
     modules = [
       # specific package overrides would go here

package-set.nix

@@ -1,5 +1,5 @@
-let f = { hackage, pkgs, pkg-def, pkg-def-overlays ? [], modules ? [] }: let
-  buildModules = f { inherit hackage pkg-def pkg-def-overlays modules; pkgs = pkgs.buildPackages; };
+let f = { hackage, pkgs, pkg-def, pkg-def-extras ? [], modules ? [] }: let
+  buildModules = f { inherit hackage pkg-def pkg-def-extras modules; pkgs = pkgs.buildPackages; };
 in pkgs.lib.evalModules {
   modules = modules ++ [
     ({ lib, ... }: {
@@ -33,7 +33,7 @@ in pkgs.lib.evalModules {
         # or
         # { y = ./foo.nix; }
         # As such the desugarer desugars this short hand syntax.
-        let desugar = overlay:
+        let desugar = extras:
           let
             isPath  = x: builtins.typeOf x == "path";
             # rewrite
@@ -51,19 +51,19 @@ in pkgs.lib.evalModules {
             # into
             #   x.revision = import ./some/path;
             expand-paths = pkg: if !(isPath pkg.revision) then pkg else { revision = import pkg.revision; };
-          # apply injection and expansion to the "packages" in overlay.
+          # apply injection and expansion to the "packages" in extras.
           in lib.mapAttrs (k: v: if k != "packages"
                               then v
                               else lib.mapAttrs (_: pkg: (expand-paths (inject-revision pkg))) v)
-                                                (inject-packages overlay);
-        # fold any potential `pkg-def-overlays`
+                                                (inject-packages extras);
+        # fold any potential `pkg-def-extras`
         # onto the `pkg-def`.
         #
         # This means you can have a base definition (e.g. stackage)
         # and augment it with custom packages to your liking.
         in foldl' lib.recursiveUpdate
             (pkg-def hackage)
-            (map (p: desugar (if builtins.isFunction p then p hackage else p)) pkg-def-overlays)
+            (map (p: desugar (if builtins.isFunction p then p hackage else p)) pkg-def-extras)
       ;
 
     })

test/builder-haddock/default.nix

@@ -9,7 +9,7 @@ let
     #   plan-to-nix dist-newstyle/cache/plan.json > plan.nix
     #   cabal-to-nix test-haddock.cabal > test-haddock.nix
     pkg-def = import ./plan.nix;
-    pkg-def-overlays = [
+    pkg-def-extras = [
       { test-haddock = ./test-haddock.nix; }
     ];
     modules = [

test/cabal-22/default.nix

@@ -5,7 +5,7 @@ with stdenv.lib;
 let
   pkgSet = mkPkgSet {
     pkg-def = import ./plan.nix;
-    pkg-def-overlays = [
+    pkg-def-extras = [
       { project = ./project.nix; }
     ];
     modules = [ ];

test/cabal-simple/default.nix

@@ -10,7 +10,7 @@ let
   # 3. plan-to-nix ./dist-newstyle/cache/plan.json > plan.nix
   pkgSet = mkPkgSet {
     pkg-def = import ./plan.nix;
-    pkg-def-overlays = [
+    pkg-def-extras = [
       { cabal-simple = ./cabal-simple.nix;
       }
     ];

test/cabal-sublib/default.nix

@@ -10,7 +10,7 @@ let
   # 3. plan-to-nix ./dist-newstyle/cache/plan.json > plan.nix
   pkgSet = mkPkgSet {
     pkg-def = import ./plan.nix;
-    pkg-def-overlays = [
+    pkg-def-extras = [
       { cabal-sublib = ./cabal-sublib.nix;
       }
     ];