git.iko.soy/typeable/nixpkgs
on master help sign in
haskell: improve documentation on ghcWithHoogle and developPackage
commit07e697d22d91a4f1ae75da32c457a432f46d7bd1 authorJoe Hermaszewski <git@monoid.al> dateWed 11 Nov 2020, 11:01 (6 years ago) parentc3b35f2
1 file changed+10
pkgs/development/haskell-modules/make-package-set.nix+10
pkgs/development/haskell-modules/make-package-set.nix+10
@@ -228,6 +228,9 @@ in package-set { inherit pkgs stdenv callPackage; } self // {
228228 # optional set of arbitrary overrides, and an optional haskell package
229229 # modifier, return a derivation appropriate for nix-build or nix-shell to
230230 # build that package.
231+ # If 'returnShellEnv' is true this returns a derivation which will give you
232+ # an environment suitable for developing the listed packages with an
233+ # incremental tool like cabal-install.
231234 developPackage =
232235 { root
233236 , name ? builtins.baseNameOf root
@@ -245,6 +248,13 @@ in package-set { inherit pkgs stdenv callPackage; } self // {
245248
246249 ghcWithPackages = selectFrom: withPackages (selectFrom self);
247250
251+ # Put 'hoogle' into the derivation's PATH with a database containing all
252+ # the package's dependencies; run 'hoogle server --local' in a shell to
253+ # host a search engine for the dependencies.
254+ #
255+ # To reload the Hoogle server automatically on .cabal file changes try
256+ # this:
257+ # echo *.cabal | entr -r -- nix-shell --run 'hoogle server --local'
248258 ghcWithHoogle = selectFrom:
249259 let
250260 packages = selectFrom self;