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

doc/hooks/cernlib: document CERNLIB hook #341691

Merged
merged 1 commit into from
Sep 14, 2024

Conversation

tomodachi94
Copy link
Member

Description of changes

Attempt to document the setup hook included in the cernlib package.

I'm unsure of why this setup hook exists. I used GitHub search and found one non-Nixpkgs Makefile which uses the same variables the hook sets, but I can't find anything else. Input from @veprbl (the maintainer and creator of the setup hook) would be greatly appreciated.

Part of #341479.

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.11 Release Notes (or backporting 23.11 and 24.05 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.

Copy link
Member

@veprbl veprbl left a comment

Choose a reason for hiding this comment

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

LGTM

@tomodachi94
Copy link
Member Author

tomodachi94 commented Sep 14, 2024

@veprbl do you know if the environment variables set by this setup hook are documented anywhere? That is the chief reason this PR is a draft.

@veprbl
Copy link
Member

veprbl commented Sep 14, 2024

I don't think there is some deep meaning behind the variables, it's just how their build system was setup, and downstream applications did rely on those too. You can find descriptions in the table at https://cernlib.web.cern.ch/install/install.html .

@tomodachi94
Copy link
Member Author

I've gone ahead and added a link to the documentation for those variables for completeness' sake.

@tomodachi94 tomodachi94 marked this pull request as ready for review September 14, 2024 02:40
@veprbl veprbl merged commit 94eeb71 into NixOS:master Sep 14, 2024
23 checks passed
@tomodachi94 tomodachi94 deleted the enhance/doc/hooks/cernlib branch September 14, 2024 05:52
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