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.

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

zinit: Fixes missing man pages #313045

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

connorgmeehan
Copy link

Description of changes

Copies the zinit docs to the output of the derivation to fix error when zinit initialises.

Zinit tries to copy the docs into the man pages, because these files aren't copied out to the ouput it errors. This causes an ugly error log when initialising zsh and can interfere with some nix-shell/zsh integration plugins.

⚠️ Unsure if this correct approach. Currently I'm copying the file to the outdir and letting zinit copy it to the manpages. Should I make the derivation copy the file to the man pages directory for immutabilities sake?

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 24.05 Release Notes (or backporting 23.05 and 23.11 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

@@ -24,6 +24,9 @@ stdenvNoCC.mkDerivation rec {
install -m0644 zinit{,-side,-install,-autoload}.zsh "$outdir"
install -m0755 share/git-process-output.zsh "$outdir"

mkdir "$outdir/doc"
install -m0644 doc/zinit.1 "$outdir/doc/zinit.1"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use installManpage in installShellFiles (add it to nativeBuildInputs).

Suggested change
install -m0644 doc/zinit.1 "$outdir/doc/zinit.1"
installManpage doc/zinit.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants