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.
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
git: Add a doc output for the HTML and text files #86848
Conversation
LGTM - not sure if gitFull should get the doc; the man pages are still available right? |
Yes. And to document the exact file changes:
|
I'm ok with merging, the only reservation I have is that the doc output isn't very discoverable, so people looking for the info or docs have to know to install it. Or is there a nixpkgs-wide setting? |
Yes, that's unfortunate and AFAIK we don't have a good solution for this (we could add an alias like
On NixOS there's |
|
This will install the HTML and text documentation into a separate output so that users can install it without having to rebuild Git. Previously only `doc/git/git-subtree.html` was installed (which is now in $doc as well). The current output sizes are as follows: ``` $ du -sh $(nix-build -A git) 47M /nix/store/wyqgalp61kmavx06rams7z8jz177nd8y-git-2.26.2 $ du -sh $(nix-build -A git.doc) 14M /nix/store/6zi22fl5xc3sg23d9shsviinvwk89wvq-git-2.26.2-doc ``` Fixes NixOS#86022 (at least partly since the output has to be installed).
d27f3d2
to
9f2faa1
Compare
@wmertens I applied your changes, feel free to squash the commits (the second one is only for reviewing).
Yes,
I'm not sure if this change is important enough (mainly since it's difficult to filter the changelog for relevant entries), but I've added a short note anyway ;) |
In that case it specified $doc output but didn't even create it. I expect it's better to do it this way instead of creating it as an empty directory. (Only the failed builds get rebuilt by this commit.)
This will install the HTML and text documentation into a separate output
so that users can install it without having to rebuild Git.
Previously only
doc/git/git-subtree.html
was installed (which is nowin $doc as well).
The current output sizes are as follows:
Fixes #86022 (at least partly since the output has to be installed).
Motivation for this change
This is a draft for #86022. It basically works, but we could e.g. discuss if we should install this output by default for
gitFull
among other things.Things done
sandbox
innix.conf
on non-NixOS linux)nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
./result/bin/
)nix path-info -S
before and after)