public
/
nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add minimal docs for callHackage and friends 

Specifically haskellSrc2nix, callHackage, and callHackageDirect. Other
functions should probably also be documented, but it's at least a start.
This commit is contained in:
Bryan Richter 2019-05-14 08:18:02 +03:00
parent 59a733edae
commit 6a74ba96fd
No known key found for this signature in database
GPG Key ID: 3EDE726D934B289C
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
pkgs/development/haskell-modules/make-package-set.nix
View File

@ -118,6 +118,7 @@ let
inherit packages; inherit packages;
}; };
# Use cabal2nix to create a default.nix for the package sources found at 'src'.
haskellSrc2nix = { name, src, sha256 ? null, extraCabal2nixOptions ? "" }: haskellSrc2nix = { name, src, sha256 ? null, extraCabal2nixOptions ? "" }:
let let
sha256Arg = if isNull sha256 then "--sha256=" else ''--sha256="${sha256}"''; sha256Arg = if isNull sha256 then "--sha256=" else ''--sha256="${sha256}"'';
@ -174,8 +175,14 @@ in package-set { inherit pkgs stdenv callPackage; } self // {
inherit (haskellLib) packageSourceOverrides; inherit (haskellLib) packageSourceOverrides;
# callHackage :: Text -> Text -> AttrSet -> HaskellPackage
#
# e.g., while overriding a package set:
# '... foo = self.callHackage "foo" "1.5.3" {}; ...'
callHackage = name: version: callPackageKeepDeriver (self.hackage2nix name version); callHackage = name: version: callPackageKeepDeriver (self.hackage2nix name version);
# callHackageDirect :: Text -> Text -> AttrSet -> HaskellPackage
#
# This function does not depend on all-cabal-hashes and therefore will work # This function does not depend on all-cabal-hashes and therefore will work
# for any version that has been released on hackage as opposed to only # for any version that has been released on hackage as opposed to only
# versions released before whatever version of all-cabal-hashes you happen # versions released before whatever version of all-cabal-hashes you happen