Skip to content
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

Jump to bottom

Revert patch: add "doc" to ghc wrapper #77442

Merged
merged 1 commit into from
Jan 10, 2020
Merged

Revert patch: add "doc" to ghc wrapper #77442

merged 1 commit into from
Jan 10, 2020

Conversation

peti
Copy link
Member

@peti peti commented Jan 10, 2020 •
edited
Loading

Reverts #76842. This change breaks ghcWithHoogle:

$ nix-build --no-out-link -E 'with import <nixpkgs> {}; haskellPackages.ghcWithHoogle (pkgs: with pkgs; [aeson cabal-plan])'
these derivations will be built:
  /nix/store/hq66xwgclahnv7qlhqhqxd9n81fv8f5s-ghc-8.6.5-with-packages.drv
building '/nix/store/hq66xwgclahnv7qlhqhqxd9n81fv8f5s-ghc-8.6.5-with-packages.drv'...
collision between `/nix/store/ds8hl24am8gmgx1dlzy7fmpjymdw5q99-uuid-types-1.0.3-doc/share/doc/uuid-types-1.0.3/html/uuid-types.haddock' and `/nix/store/v7lspi47i8xf8wkgqww4k3d1ps871ajd-uuid-types-1.0.3-doc/share/doc/uuid-types-1.0.3/html/uuid-types.haddock'
builder for '/nix/store/hq66xwgclahnv7qlhqhqxd9n81fv8f5s-ghc-8.6.5-with-packages.drv' failed with exit code 255

Apparently, the change causes file conflicts that did not occur before.

Ping @matthewbauer.

@peti peti added 0.kind: question Requests for a specific question to be answered 6.topic: haskell labels Jan 10, 2020
@peti peti self-assigned this Jan 10, 2020
@peti peti mentioned this pull request Jan 10, 2020
Merged
3 tasks
@peti peti merged commit d1bd0fb into master Jan 10, 2020
@peti peti deleted the revert-76842-add-doc-to-ghc-wrapper branch January 10, 2020 19:25
@cdepillabout
Copy link
Member

Also cc @GuillaumeDesforges who opened the originally issue (#76837) that triggered the fix (#76842) from @matthewbauer.

@GuillaumeDesforges GuillaumeDesforges mentioned this pull request Jan 11, 2020
Open
@matthewbauer
Copy link
Member

My bad! I think we just need allowCollisions but I can reopen with that.

matthewbauer added a commit that referenced this pull request Jan 11, 2020
@matthewbauer
Revert "add doc to ghc wrapper"
2395ac6 
This reverts commit 93aabab.
This reverts commit e915608.

Based on change in master at d1bd0fb
opened in #77442
matthewbauer added a commit to matthewbauer/nixpkgs that referenced this pull request Jan 11, 2020
@matthewbauer
Revert "Revert "add doc to ghc wrapper""
780cca7 
This reverts commit 2395ac6.

Added allowCollisions to fix the issue mentioned in NixOS#77442
@peti
Copy link
Member Author

peti commented Jan 12, 2020

I don't like the notion of allowing collisions very much, to be honest.

@sternenseemann sternenseemann mentioned this pull request Jan 14, 2023
Merged
13 tasks
sternenseemann added a commit to sternenseemann/nixpkgs that referenced this pull request Jan 15, 2023
@sternenseemann
ghc.withPackages: install documentation to -with-packages output
727491c 
* Will make it so that GHC.Paths's docdir NIX_GHC_DOCDIR points to an
  actual directory.

* Documentation of all packages in the environment is available in
  `$out/share/doc`.

This has previously been attempted in NixOS#76842 and reverted in NixOS#77442,
since documentation can collide when the libraries wouldn't (thanks to
the hash in the lib filename). `symlinkJoin` allows collision, so this
solution should be akin to NixOS#77523 (minus `buildEnv`, one step at a
time). `installDocumentation = false` restores the old behavior.

Collision in the documentation only happen if the dependency closure of
the given packages has more than one different derivation for the same
library of the very same version. I'm personally inclined not to claim
that our infrastructure does anything sensible in this case.
Additionally, the documentation is likely largely the same in such
cases (unless it is heavily patched).

Resolves NixOS#150666.
Resolves NixOS#76837.
Closes NixOS#150968.
Closes NixOS#77523.
xanderio pushed a commit to xanderio/nixpkgs that referenced this pull request Feb 13, 2023
@sternenseemann @xanderio
ghc.withPackages: install documentation to -with-packages output
875dc1a 
* Will make it so that GHC.Paths's docdir NIX_GHC_DOCDIR points to an
  actual directory.

* Documentation of all packages in the environment is available in
  `$out/share/doc`.

This has previously been attempted in NixOS#76842 and reverted in NixOS#77442,
since documentation can collide when the libraries wouldn't (thanks to
the hash in the lib filename). `symlinkJoin` allows collision, so this
solution should be akin to NixOS#77523 (minus `buildEnv`, one step at a
time). `installDocumentation = false` restores the old behavior.

Collision in the documentation only happen if the dependency closure of
the given packages has more than one different derivation for the same
library of the very same version. I'm personally inclined not to claim
that our infrastructure does anything sensible in this case.
Additionally, the documentation is likely largely the same in such
cases (unless it is heavily patched).

Resolves NixOS#150666.
Resolves NixOS#76837.
Closes NixOS#150968.
Closes NixOS#77523.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@basvandijk basvandijk Awaiting requested review from basvandijk

@cdepillabout cdepillabout Awaiting requested review from cdepillabout

@infinisil infinisil Awaiting requested review from infinisil

Assignees

@peti peti

Labels
0.kind: question Requests for a specific question to be answered 6.topic: haskell 10.rebuild-darwin: 1-10 10.rebuild-linux: 11-100
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@peti @cdepillabout @matthewbauer