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

treesheets: adjust output directories #163492

Closed

Conversation

DeeUnderscore
Copy link
Contributor

Description of changes

Right now, the treesheets derivation outputs docs to $out/share/doc/ This is undesirable, because if you install Treesheets into, say, your profile, you end up with its readme under ~/.nix-profile/share/doc/readme.html. This patch moves Treesheets docs to $out/share/doc/treesheets/ instead.

Also, I've moved $out/share/libexec to $out/libexec; this seems to be the common Nixpkgs convention.

Things done
  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
  • 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/)
  • 22.05 Release Notes (or backporting 21.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
    • (Release notes changes) Ran nixos/doc/manual/md-to-db.sh to update generated release notes
  • Fits CONTRIBUTING.md.

Docs are now under $out/share/doc/treesheets instead of top level in the
doc/ directory.

The libexec/ directory is now directly under $out to match Nixpkgs
conventions.
@jtojnar
Copy link
Member

jtojnar commented Mar 11, 2022

I am tackling this upstream in aardappel/treesheets#201

@DeeUnderscore
Copy link
Contributor Author

Okay, I'll keep this open in the interim until the upstream PR is merged.

@DeeUnderscore
Copy link
Contributor Author

Closing this in favor of #163872

@DeeUnderscore DeeUnderscore deleted the misc/treesheets-dirs branch April 25, 2022 22:37
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.

2 participants