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,7 +67,7 @@ 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:
 
@@ -78,14 +78,14 @@ let
         compiler = (stack-pkgs.overlay 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.overlay ] ++ 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:
 
@@ -95,7 +95,7 @@ let
         compiler = (plan-pkgs.overlay 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.overlay ] ++ pkg-def-extras;
         modules = [ ghcHackagePatches.${compiler.nix-name} ] ++ modules;
       };
 

docs/iohk-nix.md

@@ -74,7 +74,7 @@ let
     # The overlay allows extension or restriction of the set of
     # packages we are interested in. By using the stack-pkgs.overlay
     # we restrict our package set to the ones provided in stack.yaml.
-    pkg-def-overlays = [
+    pkg-def-extras = [
       stack-pkgs.overlay
       iohk-overlay.${compiler}
     ];

docs/user-guide-stack.md

@@ -45,7 +45,7 @@ let
 
   pkgSet = haskell.mkStackPkgSet {
     stack-pkgs = import ./pkgs.nix;
-    pkg-def-overlays = [];
+    pkg-def-extras = [];
     modules = [];
   };
 

docs/user-guide.md

@@ -83,7 +83,7 @@ let
   pkgSet = haskell.mkPkgSet {
     inherit pkgs;
     pkg-def = my-pkgs.pkg-def;
-    pkg-def-overlays = [
+    pkg-def-extras = [
       # this overlay will provide additional packages
       # ontop of the package set.  E.g. extra-deps
       # for stack packages. or local packages for

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, ... }: {
@@ -56,14 +56,14 @@ in pkgs.lib.evalModules {
                               then v
                               else lib.mapAttrs (_: pkg: (expand-paths (inject-revision pkg))) v)
                                                 (inject-packages overlay);
-        # fold any potential `pkg-def-overlays`
+        # 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/stack-simple/default.nix

@@ -7,7 +7,7 @@ let
   # generated by running hpack then stack-to-nix.
   pkgSet = mkStackPkgSet {
     stack-pkgs = import ./stack-pkgs.nix;
-    pkg-def-overlays = [];
+    pkg-def-extras = [];
     modules = [];
   };
 

test/with-packages/default.nix

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