Skip to content

document use of meta, src, and originalSrc attrs #325

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.

Sign up for GitHub

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

Merged
ryantm merged 1 commit into from
Sep 18, 2022
Merged

document use of meta, src, and originalSrc attrs #325

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/nixpkgs-maintainer-faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ Some attrpaths have versions appended to the end of them, like `ruby_3_0`, the n

If `nix edit $attrpath` does not open the correct file that contains the version string and fetcher hash, the update will fail.

This might not work, for example, if a package doesn't have a `meta` attr (at all, or if the package uses a builder function that is discarding the `meta` attr).

### Update already merged

If the update is already on `master`, `staging`, or `staging-next`, the update will fail.
Expand All @@ -74,6 +76,8 @@ If the update is already on `master`, `staging`, or `staging-next`, the update w

If the derivation file has no hash or source URL, it will fail.

Since `nixpkgs-update` is trying to read these from `<pkg>.src`, this can also happen if the package's source is something unexpected such as another package. You can set the fallback `originalSrc` attr so that `nixpkgs-update` can find the correct source in cases like this.

### No updateScript and no version

If the derivation file has no version and no updateScript, it will fail.
Expand Down