about summary refs log tree commit diff
path: root/pkgs
diff options
context:
space:
mode:
authorRobert Hensing <roberth@users.noreply.github.com>2024-06-26 20:16:02 +0200
committerGitHub <noreply@github.com>2024-06-26 20:16:02 +0200
commite6016dc59221564cc44f8003f32b48cb26ca2af2 (patch)
treed531c7ba057225f4c0c6b0a4a9a9a78a6b20d1f0 /pkgs
parentdb4c8df48c6aad835d4c4971c0b690ca8dc6c6ca (diff)
parent0c1fbe5fc5ac3ba43f26f86e4ddc057a1c58bb61 (diff)
Merge pull request #322556 from hercules-ci/explain-test-cabalSdist
doc: Explain cabalSdist test
Diffstat (limited to 'pkgs')
-rw-r--r--pkgs/test/haskell/cabalSdist/default.nix5
-rw-r--r--pkgs/test/haskell/cabalSdist/local/generated.nix2
2 files changed, 6 insertions, 1 deletions
diff --git a/pkgs/test/haskell/cabalSdist/default.nix b/pkgs/test/haskell/cabalSdist/default.nix
index 1031e51e4f141..c0a9d406a5039 100644
--- a/pkgs/test/haskell/cabalSdist/default.nix
+++ b/pkgs/test/haskell/cabalSdist/default.nix
@@ -12,6 +12,11 @@ lib.recurseIntoAttrs rec {
 
   localFromCabalSdist = haskellPackages.buildFromCabalSdist localRaw;
 
+  # NOTE: ./local refers to the "./." path in `./local/generated.nix`.
+  # This test makes sure that localHasNoDirectReference can actually fail if
+  # it doesn't do anything. If this test fails, either the test setup was broken,
+  # or Haskell packaging has changed the way `src` is treated in such a way that
+  # either the test or the design of `buildFromCabalSdist` needs to be reconsidered.
   assumptionLocalHasDirectReference = runCommand "localHasDirectReference" {
     drvPath = builtins.unsafeDiscardOutputDependency localRaw.drvPath;
   } ''
diff --git a/pkgs/test/haskell/cabalSdist/local/generated.nix b/pkgs/test/haskell/cabalSdist/local/generated.nix
index bfa299962bcb4..fae1e45f3d978 100644
--- a/pkgs/test/haskell/cabalSdist/local/generated.nix
+++ b/pkgs/test/haskell/cabalSdist/local/generated.nix
@@ -3,7 +3,7 @@
 mkDerivation {
   pname = "local";
   version = "0.1.0.0";
-  src = ./.;
+  src = ./.; # also referred to as ./local in the test; these are the same path constants
   isLibrary = false;
   isExecutable = true;
   executableHaskellDepends = [ base ];