haskellPackages.shellFor: fix value of NIX_GHC_DOCDIR #150968
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
KAction
requested review from
cdepillabout,
expipiplus1,
maralorn and
sternenseemann
as code owners
|
Thanks for the PR. That looks cool. One thing though: I don‘t know what |
|
Oh, wait. That function was there before your PR, too.^^ Another thing: This doesn‘t need to target staging, I suggest haskell-updates instead. Make sure to mark the PR as draft before changing merge base to prevent mass highlights from happening. |
That’s nice. But is there any tooling that actually assumes this? |
Not as far as I know, but it is nice that I can point my favorite file manager to it and get exactly matching documentation. |
github-actions
bot
added
6.topic: GNOME
Before this commit it pointed to non-existent directory, now it points to GHC user manual. What is more important, now $NIX_GHC_DOCDIR/../.. contains documentation with all dependenices, one subdirectory for dependency. Closes: NixOS#150666
KAction
force-pushed
the
fix-haskell-shell-for
branch
from
7e142b6
to
b27b969
Compare
github-actions
bot
removed
6.topic: systemd
6.topic: kernel
6.topic: python
8.has: documentation
labels
github-actions
bot
removed
6.topic: printing
6.topic: rust
6.topic: GNOME
|
Rebased. |
|
I’ll try to have a look the day after tomorrow. I would like to compare build times before and also check again how ghc-paths handles this value (and how it’s used by its reverse dependencies). E. g. if you can get doc paths of individual packages using ghc-pkg I’d prefer to hide this feature behind a flag, but we’ll see.
… On 17. Dec 2021, at 19:49, Dmitry Bogatov ***@***.***> wrote:
Rebased.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications on the go with GitHub Mobile for iOS or Android.
You are receiving this because your review was requested.
|
|
Ping? |
stale
bot
added
the
2.status: stale
sternenseemann
added a commit
to sternenseemann/nixpkgs
that referenced
this pull request
Jan 14, 2023
* 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). 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.
13 tasks
sternenseemann
added a commit
to sternenseemann/nixpkgs
that referenced
this pull request
Jan 14, 2023
* 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.
lunik1
pushed a commit
to lunik1/nixpkgs
that referenced
this pull request
Jan 29, 2023
* 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
* 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before this commit it pointed to non-existent directory, now it points to GHC
user manual. What is more important, now $NIX_GHC_DOCDIR/../.. contains
documentation with all dependenices, one subdirectory for dependency.
Closes: #150666
Ping: @sterneseemann, @maralorn