Skip to content

[Backport release-24.05] doc/haskell: Dedup and edit justStaticExecutables #319407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maralorn merged 2 commits into from
Jun 12, 2024
Merged

[Backport release-24.05] doc/haskell: Dedup and edit justStaticExecutables #319407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83934fc
doc/haskell: Dedup and edit justStaticExecutables
roberth Jun 12, 2024
0c67740
haskell-modules/generic-builder: Point doc link to stable
roberth Jun 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions doc/languages-frameworks/haskell.section.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -929,10 +929,12 @@ for this to work.
Haskell dependencies, but will still link dynamically against libc, GMP and
other system library dependencies.

If the library being built or its dependencies use their Cabal-generated
If a library or its dependencies use their Cabal-generated
`Paths_*` module, this may not work as well if GHC's dead code elimination is
unable to remove the references to the dependency's store path that module
contains. (See [nixpkgs#164630][164630] for more information.)
contains.
As a consequence, an unused reference may be created from the static binary to such a _library_ store path.
(See [nixpkgs#164630][164630] for more information.)

Nixpkgs unstable and releases from 24.11 onwards will verify that such
references are eliminated and fail the build if they are not.
Expand Down
16 changes: 2 additions & 14 deletions pkgs/development/haskell-modules/generic-builder.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,20 +118,8 @@ in
# to help prevent static Haskell binaries from having erroneous dependencies
# on GHC.
#
# Generated `Paths_*` modules include paths for the runtime library
# directory (and similar) of the package being built. If the `Paths_*`
# module is imported, this creates a dependency from the static binary
# being built to the _library_ being built (which is dynamically linked
# and depends on the GHC used to build it).
#
# To avoid this:
# 1. Build the impacted derivation.
# 2. Run `strings` on the built binary of the impacted derivation to
# locate the store paths it depends on.
# 3. Add `remove-references-to -t ${bad-store-path-in-binary}` to the
# impacted derivation's `postInstall`.
#
# See: https://github.com/NixOS/nixpkgs/issues/164630
# See https://nixos.org/manual/nixpkgs/stable/#haskell-packaging-helpers
# or its source doc/languages-frameworks/haskell.section.md
, disallowGhcReference ? false
, # Cabal 3.8 which is shipped by default for GHC >= 9.3 always calls
# `pkg-config --libs --static` as part of the configure step. This requires
Expand Down