Merge remote-tracking branch 'origin/master' into support-cabal-doctest

Author: hamishmack

docs/tutorials/getting-started.md

@@ -21,7 +21,19 @@ trusted-public-keys = [...] hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNG
 substituters = [...] https://hydra.iohk.io [...]
 ```
 
-This can be tricky to get setup properly. If you're still having trouble getting cache hits, consult the corresponding [troubleshooting section](../reference/troubleshooting#why-am-i-building-ghc).
+If you're running NixOS, you need to add/update the following in your `/etc/nixos/configuration.nix` files instead.
+
+```
+# Binary Cache for Haskell.nix
+nix.binaryCachePublicKeys = [
+  "hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ="
+];
+nix.binaryCaches = [
+  "https://hydra.iohk.io"
+];
+```
+
+This can be tricky to get setup properly. If you're still having trouble getting cache hits, consult the corresponding [troubleshooting section](../../troubleshooting#why-am-i-building-ghc).
 
 ## Scaffolding
 

hackage-src.json

@@ -1,9 +1,9 @@
 {
   "url": "https://github.com/input-output-hk/hackage.nix",
-  "rev": "f10ac1731430fcbb403dfc311b81558d6f2918a9",
-  "date": "2021-01-14T01:14:09+00:00",
-  "path": "/nix/store/d56pfsmi4fn0jy2274pnhpwmmm1xc5p2-hackage.nix-f10ac17",
-  "sha256": "18n3zl9069h7vhm7jmd6nhg99d7dd4qzkvcqvkkxyq9k2adv1zf2",
+  "rev": "f38f159df7d2b3a716c344edff4c9f630e070453",
+  "date": "2021-01-24T01:11:02+00:00",
+  "path": "/nix/store/fsgz8y98a4yrhw3slj159kmkv39bb561-hackage.nix-f38f159",
+  "sha256": "163gabnkvap4x5mpdriknhi5bz8a9mkgfq5msp5ddzm02iqw6b5v",
   "fetchSubmodules": false,
   "deepClone": false,
   "leaveDotGit": false

lib/cabal-licenses.nix

@@ -14,7 +14,8 @@ in licenses // {
       shortName = "Other License";
       fullName = "Unidentified Other License";
       url = "https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/";
-      free = false;
+      # Not setting `free` here. The license may or may not be `free`.
+      # See https://github.com/input-output-hk/haskell.nix/pull/1006
     };
   NONE = null;
 }

lib/check.nix

@@ -28,6 +28,12 @@ in stdenv.mkDerivation ({
   # component and we want it to quietly succeed.
   buildPhase = ''
     mkdir $out
+    ${
+      # Change to the source sub directory if there is one.
+      lib.optionalString (drv.srcSubDir or "" != "") ''
+        cd ${lib.removePrefix "/" drv.srcSubDir}
+      ''
+    }
 
     runHook preCheck
 

lib/clean-cabal-component.nix

@@ -58,16 +58,20 @@ in
         hsSourceDirs = builtins.map (d: combinePaths subDir d) component.hsSourceDirs
           ++ (if component.hsSourceDirs == [] then [subDir] else []);
         includeDirs = builtins.map (d: combinePaths subDir d) component.includeDirs;
-        dirsNeeded = builtins.map (d: combinePaths subDir d) (
+        # paths that will be needed (used to check if a parent dir should be included)
+        dirsNeeded =
+          # These already include subDir
              [dataDir]
           ++ hsSourceDirs
           ++ includeDirs
-          ++ package.licenseFiles
-          ++ package.extraSrcFiles
-          ++ component.extraSrcFiles
-          ++ package.extraDocFiles
-          ++ builtins.map (f: dataDir + f) package.dataFiles
-          ++ otherSourceFiles);
+          ++ builtins.map (f: combinePaths dataDir f) package.dataFiles
+          ++ otherSourceFiles
+          ++ builtins.map (d: combinePaths subDir d) (
+               # These need the subDir added
+               package.licenseFiles
+            ++ package.extraSrcFiles
+            ++ component.extraSrcFiles
+            ++ package.extraDocFiles);
         fileMatch = dir: list:
           let
             prefixes = builtins.map (f: combinePaths dir f) (

lib/import-and-filter-project.nix

@@ -24,30 +24,43 @@ in project // {
       packages = pkgs.lib.attrsets.mapAttrs (name: value:
         if builtins.isFunction value
           then value
-          else {...}@args:
-            let oldPkg = import value args;
-                packageSrc = if !pkgs.lib.strings.hasPrefix (toString projectNix) (toString oldPkg.src.content)
-                  then toString oldPkg.src.content
-                  else let
-                    subDir = pkgs.lib.strings.removePrefix "/" (
-                      pkgs.lib.strings.removePrefix (toString projectNix)
-                        (toString oldPkg.src.content));
-                    srcRepoPrefix = projectSubDir'' + ".source-repository-packages/";
-                    in if pkgs.lib.strings.hasPrefix srcRepoPrefix subDir
-                      then
-                        pkgs.lib.lists.elemAt sourceRepos (
-                          pkgs.lib.strings.toInt (pkgs.lib.strings.removePrefix srcRepoPrefix subDir))
-                      else haskellLib.appendSubDir {
-                          src = srcRoot;
-                          inherit subDir;
-                          includeSiblings = true; # Filtering sibling dirs of the package dir is done in the
-                                                  # component builder so that relative paths can be used to
-                                                  # reference project directories not in the package subDir.
-                        };
+          else {...}@args: with pkgs.lib.strings;
+            let
+              oldPkg = import value args;
+              # When the package src is in the project dir, this is the subDir it is in.
+              subDir = removePrefix "/" (removePrefix (toString projectNix)
+                                                      (toString oldPkg.src.content));
+              srcRepoPrefix = projectSubDir'' + ".source-repository-packages/";
+
+              packageInfo =
+                if !hasPrefix (toString projectNix) (toString oldPkg.src.content)
+                  then {
+                    # Source location does not match project prefix
+                    isProject = false;
+                    packageSrc = toString oldPkg.src.content;
+                  }
+                else if hasPrefix srcRepoPrefix subDir
+                  then {
+                    # The source is from a source repository
+                    isProject = false;
+                    packageSrc = pkgs.lib.lists.elemAt sourceRepos (
+                      toInt (removePrefix srcRepoPrefix subDir));
+                  }
+                else {
+                    # Source does match project prefix and it is not from a source repository
+                    isProject = true;
+                    packageSrc = haskellLib.appendSubDir {
+                      src = srcRoot;
+                      inherit subDir;
+                      includeSiblings = true; # Filtering sibling dirs of the package dir is done in the
+                                              # component builder so that relative paths can be used to
+                                              # reference project directories not in the package subDir.
+                    };
+                  };
             in oldPkg // {
-              src = (pkgs.lib).mkDefault packageSrc;
+              src = (pkgs.lib).mkDefault packageInfo.packageSrc;
               package = oldPkg.package // {
-                isProject = (pkgs.lib).mkDefault true;
+                isProject = (pkgs.lib).mkDefault packageInfo.isProject;
               };
             }) old;
     };

lib/pkgconf-nixpkgs-map.nix

@@ -155,6 +155,7 @@ pkgs:
     "webkit2gtk-4.0"                     = [ pkgs."webkitgtk" ];
     "webkit2gtk-web-extension-4.0"       = [ pkgs."webkitgtk" ];
     "webkitgtk-3.0"                      = [ pkgs."webkitgtk24x-gtk3" ]; # These are the old APIs, of which 2.4 is the last provider, so map directly to that
+    "vulkan"                             = [ pkgs."vulkan-loader" ]; # vulkan-loader provides vulkan.pc file for pkg-config.
     "X11"                                = [ pkgs.xorg."libX11" ];
     "x11"                                = [ pkgs.xorg."xlibsWrapper" ];
     "xau"                                = [ pkgs.xorg."libXau" ];

lib/system-nixpkgs-map.nix

@@ -13,6 +13,7 @@ with pkgs;
   "stdc++-6" = null;
   ssl = [ openssl ];
   z = [ zlib ];
+  pcap = [ libpcap ];
   pthread = null; # available by default
   GL = [ libGL ];
   GLU = [ libGLU ];
@@ -73,6 +74,9 @@ with pkgs;
   boost_wave = [ boost ];
   boost_wserialization = [ boost ];
   tensorflow = [ libtensorflow ];
+  # odbc package requires unixODBC packages to be installed in order to successfully
+  # compile C sources (https://github.com/fpco/odbc/blob/master/cbits/odbc.c)
+  odbc = [ unixODBC ];
   opencv = [ opencv3 ];
   icuuc = [ icu ];
   icui18n = [ icu ];