Merge remote-tracking branch 'origin/master' into hkm/combined-derivations

Author: hamishmack

.buildkite/pipeline.yml

@@ -1,6 +1,76 @@
 steps:
-  - label: 'Run tests with ghc8107'
-    command: "./test/tests.sh ghc8107"
+  - label: 'Run tests with ghc8107: Running the nix-build tests...'
+    command: "./test/tests.sh ghc8107 nix-build"
+    agents:
+      system: x86_64-linux
+
+  - label: 'Run tests with ghc8107: Running the unit tests...'
+    command: "./test/tests.sh ghc8107 unit-tests"
+    agents:
+      system: x86_64-linux
+
+  - label: 'Run tests with ghc8107: Checking that a nix-shell works for runghc...'
+    command: "./test/tests.sh ghc8107 runghc"
+    agents:
+      system: x86_64-linux
+
+  - label: 'Run tests with ghc8107: Checking that a nix-shell works for cabal...'
+    command: "./test/tests.sh ghc8107 cabal"
+    agents:
+      system: x86_64-linux
+
+  - label: 'Run tests with ghc8107: Checking that a nix-shell works for cabal (doExactConfig component)...'
+    command: "./test/tests.sh ghc8107 cabal-doExactConfig"
+    agents:
+      system: x86_64-linux
+
+  - label: 'Run tests with ghc8107: Checking that a nix-shell works for a project with test-suite build-tools and benchmarks...'
+    command: "./test/tests.sh ghc8107 tests-benchmarks"
+    agents:
+      system: x86_64-linux
+
+  - label: 'Run tests with ghc8107: Checking that a nix-shell works for a multi-target project...'
+    command: "./test/tests.sh ghc8107 multi-target"
+    agents:
+      system: x86_64-linux
+
+  - label: 'Run tests with ghc8107: Checking shellFor works for a cabal project, multiple packages...'
+    command: "./test/tests.sh ghc8107 shellFor-single-package"
+    agents:
+      system: x86_64-linux
+
+  - label: 'Run tests with ghc8107: Checking shellFor works for a cabal project, single package...y'
+    command: "./test/tests.sh ghc8107 shellFor-multiple-package"
+    agents:
+      system: x86_64-linux
+
+  - label: 'Run tests with ghc8107: Checking shellFor works for a cabal project, single package...'
+    command: "./test/tests.sh ghc8107 shellFor-hoogle"
+    agents:
+      system: x86_64-linux
+
+  - label: 'Run tests with ghc8107: Checking shellFor does not depend on given packages...y'
+    command: "./test/tests.sh ghc8107 shellFor-not-depends"
+    agents:
+      system: x86_64-linux
+
+  - label: 'Run tests with ghc8107: Checking the maintainer scripts...y'
+    command: "./test/tests.sh ghc8107 maintainer-scripts"
+    agents:
+      system: x86_64-linux
+
+  - label: 'Run tests with ghc8107: Checking that plan construction works with extra Hackages...'
+    command: "./test/tests.sh ghc8107 plan-extra-hackages"
+    agents:
+      system: x86_64-linux
+
+  - label: 'Run tests with ghc8107: Checking that package with extra Hackages can be build...'
+    command: "./test/tests.sh ghc8107 build-extra-hackages"
+    agents:
+      system: x86_64-linux
+
+  - label: 'Run tests with ghc8107: End-2-end test of hix project initialization and flakes development shell ...'
+    command: "./test/tests.sh ghc8107 hix"
     agents:
       system: x86_64-linux
 
@@ -41,7 +111,7 @@ steps:
 
   - label: 'Check that the haskell.nix roots do not require IFDs'
     command:
-      - yes | nix build .#roots.x86_64-linux --option allow-import-from-derivation false
+      - nix build .#roots.x86_64-linux --accept-flake-config --option allow-import-from-derivation false
     agents:
       system: x86_64-linux
 
@@ -50,3 +120,10 @@ steps:
       - nix-instantiate release.nix -A required-unstable-ghc8107-x86_64-darwin-native --show-trace --builders ''
     agents:
       system: x86_64-linux
+
+  - label: 'Check hix -- run github:haskell/cabal/3.8#cabal-install:exe:cabal -- --version'
+    command:
+      - "HIX_DIR=$(mktemp -d) nix run .#hix --accept-flake-config -- run github:haskell/cabal/3.8#cabal-install:exe:cabal --accept-flake-config --override-input haskellNix . -- --version"
+    agents:
+      system: x86_64-linux
+

docs/dev/nix-tools-pin.md

@@ -1,16 +1,13 @@
 ## How to update [`nix-tools`](https://github.com/input-output-hk/nix-tools)
 
 1. Use niv to update the sources.json:
-
    ```
-   niv update nix-tools
+   nix flake lock --update-input nix-tools
    ```
 
-
 2. If `nix-tools.cabal` or `plan-to-nix` have changed, check the
    materialized files for each of the compiler nix name in
    `ls -d materialized/ghc*/nix-tools` with:
-
    ```
    nix-build scripts/check-compiler-materialization --argstr compiler-nix-name ghc884
    ```

flake.nix

@@ -137,7 +137,7 @@
 
       packages = ((self.internal.compat { inherit system; }).hix).apps;
 
-      devShells.${system}.default = with self.legacyPackages.${system};
+      devShells.default = with self.legacyPackages.${system};
         mkShell {
           buildInputs = [
             nixUnstable

hix/default.nix

@@ -27,7 +27,9 @@ let
       dump-path|eval|log|path-info|search|show-derivation|sign-paths|verify|why-depends)
         nix $cmd -f ${hixProject} ${args} "$@"
         ;;
-      flake|build|develop|run)
+      flake|build|develop|run|profile)
+        # Put the flake files for remote URLs in $HOME/.hix by default
+        HIX_DIR="''${HIX_DIR:-$HOME/.hix}"
         while(($#)); do
           arg=$1
           case $arg in
@@ -45,22 +47,26 @@ let
               ;;
             github:*#*)
               SRC="''${arg%%#*}"
-              args+=("path:${hixProject}#''${arg#*#}" --override-input src "$SRC")
-              is_github=true
+              FLAKE=$HIX_DIR/$SRC
+              args+=("path:$FLAKE#''${arg#*#}" --override-input src "$SRC")
+              has_input_src=true
               ;;
             github:*)
               SRC="$arg"
-              args+=("path:${hixProject}" --override-input src "$SRC")
-              is_github=true
+              FLAKE=$HIX_DIR/$SRC
+              args+=("path:$FLAKE" --override-input src "$SRC")
+              has_input_src=true
               ;;
             *#*)
               SRC="''${arg%%#*}"
-              args+=("path:$SRC/.hix-flake#''${arg#*#}" --override-input src "$SRC")
+              FLAKE=$SRC/.hix-flake
+              args+=("path:$FLAKE#''${arg#*#}" --override-input src "$SRC")
               has_input_src=true
               ;;
             .*)
               SRC="$arg"
-              args+=("path:$SRC/.hix-flake" --override-input src "$SRC")
+              FLAKE=$SRC/.hix-flake
+              args+=("path:$FLAKE" --override-input src "$SRC")
               has_input_src=true
               ;;
             *)
@@ -69,27 +75,24 @@ let
           esac
           shift
         done
-        if [ "$is_github" != true ]; then
-          if [ "$has_input_src" != true ]; then
-            SRC=.
-            args+=("path:$SRC/.hix-flake" --override-input src "$SRC")
-          fi
-          # Make a temporary flake if we have not already
-          if [ ! -d $SRC/.hix-flake ]; then
-            mkdir $SRC/.hix-flake
-          fi
-          HIX_FLAKE="$(mktemp -d)/flake.nix"
-          sed 's|EVAL_SYSTEM|${pkgs.stdenv.hostPlatform.system}|' < ${hixProject}/flake.nix > $HIX_FLAKE
-          if ! cmp $HIX_FLAKE $SRC/.hix-flake/flake.nix &>/dev/null; then
-            if [ -e $SRC/.hix-flake/flake.lock ]; then
-              echo "Updating $SRC/.hix-flake/flake.nix and deleting old $SRC/.hix-flake/flake.lock"
-              rm $SRC/.hix-flake/flake.lock
-            else
-              echo "Updating $SRC/.hix-flake/flake.nix" 
-            fi
-            cp $HIX_FLAKE $SRC/.hix-flake/flake.nix
-            chmod +w $SRC/.hix-flake/flake.nix
+        if [ "$has_input_src" != true ]; then
+          SRC=.
+          FLAKE=$SRC/.hix-flake
+          args+=("path:$FLAKE" --override-input src "$SRC")
+        fi
+        # Make a temporary flake if we have not already
+        mkdir -p $FLAKE
+        HIX_FLAKE="$(mktemp -d)/flake.nix"
+        sed 's|EVAL_SYSTEM|${pkgs.stdenv.hostPlatform.system}|' < ${hixProject}/flake.nix > $HIX_FLAKE
+        if ! cmp $HIX_FLAKE $FLAKE/flake.nix &>/dev/null; then
+            if [ -e $FLAKE/flake.lock ]; then
+            echo "Updating $FLAKE/flake.nix and deleting old $FLAKE/flake.lock"
+            rm $FLAKE/flake.lock
+          else
+            echo "Updating $FLAKE/flake.nix" 
           fi
+          cp $HIX_FLAKE $FLAKE/flake.nix
+          chmod +w $FLAKE/flake.nix
         fi
         nix $cmd "''${args[@]}"
         ;;

hix/init/nix/hix.nix

@@ -2,12 +2,13 @@
   # name = "project-name";
   compiler-nix-name = "ghc8107"; # Version of GHC to use
 
-  crossPlatforms = p: pkgs.lib.optionals pkgs.stdenv.hostPlatform.isx86_64 ([
-    p.mingwW64
-    p.ghcjs
-  ] ++ pkgs.lib.optionals pkgs.stdenv.hostPlatform.isLinux [
-    p.musl64
-  ]);
+  # Cross compilation support:
+  # crossPlatforms = p: pkgs.lib.optionals pkgs.stdenv.hostPlatform.isx86_64 ([
+  #   p.mingwW64
+  #   p.ghcjs
+  # ] ++ pkgs.lib.optionals pkgs.stdenv.hostPlatform.isLinux [
+  #   p.musl64
+  # ]);
 
   # Tools to include in the development shell
   shell.tools.cabal = "latest";

mkdocs.yml

@@ -28,8 +28,9 @@ pages:
   - 'Motivation': motivation.md
   - 'Architecture': architecture.md
   - 'Tutorials':
-    - 'Getting Started': tutorials/getting-started.md
+    - 'Getting started': tutorials/getting-started.md
     - 'Getting started with Flakes': tutorials/getting-started-flakes.md
+    - 'Getting started with Hix': tutorials/getting-started-hix.md
     - 'Creating a development environment': tutorials/development.md
     - 'Sourcing files only part of git repository using cleanGit': tutorials/clean-git.md
     - 'Handling git repositories in projects': tutorials/source-repository-hashes.md
@@ -38,6 +39,8 @@ pages:
     - 'Materialization: Speeding up Nix evaluation': tutorials/materialization.md
     - 'Cross-compiling your project': tutorials/cross-compilation.md
     - 'Generating coverage information': tutorials/coverage.md
+    - 'Build a specific package from Hackage or Stackage': tutorials/building-package-from-stackage-hackage.md
+    - 'Content addressed derivations': tutorials/ca-derivations.md
   - 'Reference':
     - 'Supported GHC versions': reference/supported-ghc-versions.md
     - 'Command-line tools': reference/commands.md
@@ -49,11 +52,13 @@ pages:
   - 'Dev Notes':
     - 'Architecture': dev/dev-architecture.md
     - 'Installing nix-tools': dev/installing-nix-tools.md
+    - 'How to update nix-tools': dev/nix-tools-pin.md
     - 'Manually generating Nix expressions': dev/manually-generating-nix-expressions.md
     - 'Maintainer Scripts': dev/maintainer-scripts.md
     - 'Nixpkgs Pin': dev/nixpkgs-pin.md
     - 'Removing withPackage wrapper': dev/removing-with-package-wrapper.md
     - 'Test Suite': dev/tests.md
     - 'Adding a new GHC version': dev/adding-new-ghc.md
     - 'Coverage': dev/coverage.md
+    - 'Making changes to Hix': dev/hix.md
   - 'ChangeLog': changelog.md

overlays/haskell.nix

@@ -801,11 +801,10 @@ final: prev: {
 
         # `project'` and `project` automatically select between `cabalProject`
         # and `stackProject` (when possible) by looking for `stack.yaml` or
-        # `cabal.project` files.  If both exist we can pass in one of:
+        # `cabal.project` files.  If both exist it uses the `cabal.project` file.
+        # To override this pass in:
         #     `projectFileName = "stack.yaml;"`
-        #     `projectFileName = "cabal.project";`
-        # to let it know which to choose (or pick another name).  If the
-        # selected file ends in a `.yaml` it is assumed to be for `stackProject`.
+        # If the selected file ends in a `.yaml` it is assumed to be for `stackProject`.
         # If neither `stack.yaml` nor `cabal.project` exist `cabalProject` is
         # used (as it will use a default `cabal.project`).
         project' = projectModule:
@@ -829,8 +828,8 @@ final: prev: {
                 then projectFileName  # Prefer the user selected project file name
                 else
                   if stackYamlExists && cabalProjectExists
-                    then throw ("haskell-nix.project : both `stack.yaml` and `cabal.project` files exist "
-                      + "set `projectFileName = \"stack.yaml\";` or `projectFileName = \"cabal.project\";`")
+                    then __trace ("haskell-nix.project : both `stack.yaml` and `cabal.project` files exist.  Using `cabal.project`. "
+                      + "set `projectFileName = \"stack.yaml\";` to override this.`") "cabal.project"
                     else
                       if stackYamlExists
                         then "stack.yaml"      # stack needs a stack.yaml

scripts/update-external.nix

@@ -35,5 +35,7 @@ in
 
     cd ..
 
-    yes | nix --experimental-features 'nix-command flakes' flake lock --update-input ${name}
+    nix flack lock --accept-flake-config \
+                   --experimental-features 'nix-command flakes' \
+                   --update-input ${name}
   ''