dev/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

doc/../haskell.section.md: Make a bit clearer and more beginner friendly

Browse Source
This commit is contained in:
maralorn 2023-07-15 02:17:41 +02:00
parent 7764e28784
commit 85331ccd98
No known key found for this signature in database
1 changed files with 32 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
doc/languages-frameworks/haskell.section.md
View File

@ -45,16 +45,17 @@ The attribute names in `haskellPackages` always correspond with their name on
Hackage. Since Hackage allows names that are not valid Nix without escaping, Hackage. Since Hackage allows names that are not valid Nix without escaping,
you need to take care when handling attribute names like `3dmodels`. you need to take care when handling attribute names like `3dmodels`.
For packages that are part of [Stackage], we use the version prescribed by a For packages that are part of [Stackage] (a curated set of known to be
Stackage solver (usually the current LTS one) as the default version. For all compatible packages), we use the version prescribed by a Stackage snapshot
other packages we use the latest version from Hackage. See (usually the current LTS one) as the default version. For all other packages we
[below](#haskell-available-versions) to learn which versions are provided use the latest version from [Hackage](https://hackage.org) (the repository of
exactly. basically all open source Haskell packages). See [below](#haskell-available-
versions) for a few more details on this.
Roughly half of the 16K packages contained in `haskellPackages` don't actually Roughly half of the 16K packages contained in `haskellPackages` don’t actually
build and are marked as broken semi-automatically. Most of those packages are build and are [marked as broken semi-automatically](https://github.com/NixOS/nixpkgs/blob/haskell-updates/pkgs/development/haskell-modules/configuration-hackage2nix/broken.yaml).
deprecated or unmaintained, but sometimes packages that should build, do not Most of those packages are deprecated or unmaintained, but sometimes packages
build. Very often fixing them is not a lot of work. that should build, do not build. Very often fixing them is not a lot of work.
<!-- <!--
TODO(@sternenseemann): TODO(@sternenseemann):
@ -126,19 +127,23 @@ Every package set also re-exposes the GHC used to build its packages as `haskell
### Available package versions {#haskell-available-versions} ### Available package versions {#haskell-available-versions}
We aim for a “blessed” package set which only contains one version of each We aim for a “blessed” package set which only contains one version of each
package, like Stackage (and based on it) but with more packages. Normally in package, like [Stackage], which is a curated set of known to be compatible
nixpkgs the number of building Haskell packages is roughly two to three times packages. We use the version information from Stackage snapshots and extend it
the size of Stackage. For choosing the version to use for a certain package we with more packages. Normally in Nixpkgs the number of building Haskell packages
use the following rules: is roughly two to three times the size of Stackage. For choosing the version to
use for a certain package we use the following rules:
1. By default, for every package `haskellPackages.foo` is the newest version 1. By default, for `haskellPackages.foo` is the newest version of the package
found on Hackage (at the time of the last update of our package set). `foo` found on [Hackage](https://hackage.org), which is the central registry
2. If the Stackage snapshot that we use (usually the newest LTS snapshot) of all open source Haskell packages. Nixpkgs contains a reference to a pinned
contains a package, we use the Stackage version as default version for that Hackage snapshot, thus we use the state of Hackage as of the last time we
package. updated this pin.
3. For some packages, which are not on Stackage, we have manual overrides to 2. If the [Stackage] snapshot that we use (usually the newest LTS snapshot)
set the default version to a version older than the newest on Hackage. We do contains a package, [we use instead the version in the Stackage snapshot as
this to get them or their reverse dependencies to compile in our package set. default version for that package.](https://github.com/NixOS/nixpkgs/blob/haskell-updates/pkgs/development/haskell-modules/configuration-hackage2nix/stackage.yaml)
3. For some packages, which are not on Stackage, we have if necessary [manual
overrides to set the default version to a version older than the newest on
Hackage.](https://github.com/NixOS/nixpkgs/blob/haskell-updates/pkgs/development/haskell-modules/configuration-hackage2nix/main.yaml)
4. For all packages, for which the newest Hackage version is not the default 4. For all packages, for which the newest Hackage version is not the default
version, there will also be a `haskellPackages.foo_x_y_z` package with the version, there will also be a `haskellPackages.foo_x_y_z` package with the
newest version. The `x_y_z` part encodes the version with dots replaced by newest version. The `x_y_z` part encodes the version with dots replaced by
@ -146,9 +151,12 @@ underscores. When the newest version changes by a new release to Hackage the
old package will disappear under that name and be replaced by a newer one under old package will disappear under that name and be replaced by a newer one under
the name with the new version. The package name including the version will the name with the new version. The package name including the version will
also disappear when the default version e.g. from Stackage catches up with the also disappear when the default version e.g. from Stackage catches up with the
newest version from Hackage. newest version from Hackage. E.g. if `haskellPackages.foo` gets updated from
5. For some packages, we also manually add other `haskellPackages.foo_x_y_z` 1.0.0 to 1.1.0 the package `haskellPackages.foo_1_1_0` becomes obsolete and
versions, if they are required for a certain build. gets dropped.
5. For some packages, we also [manually add other `haskellPackages.foo_x_y_z`
versions](https://github.com/NixOS/nixpkgs/blob/haskell-updates/pkgs/development/haskell-modules/configuration-hackage2nix/main.yaml),
if they are required for a certain build.
Relying on `haskellPackages.foo_x_y_z` attributes in derivations outside Relying on `haskellPackages.foo_x_y_z` attributes in derivations outside
nixpkgs is discouraged because they may change or disappear with every package nixpkgs is discouraged because they may change or disappear with every package