check-meta.nix: make non-source consistent with documentation#175495
Merged
piegamesde merged 2 commits intomasterfrom Jan 4, 2023
unknown repository
Merged
check-meta.nix: make non-source consistent with documentation#175495piegamesde merged 2 commits intomasterfrom unknown repository
piegamesde merged 2 commits intomasterfrom
unknown repository
Conversation
13 tasks
Author
|
@risicle should be added as a reviewer (am I able to add reviewers to my own PRs?) |
Member
Yes it you're a member of the maintainer team which you can join by being a maintainer of a package and accepting the invite |
Author
Yeah, I really procrastinated a long time before doing this. |
Author
|
Resolved the merge conflict and squashed. |
Contributor
|
What error does this now give if you assign a single |
Author
|
Using these instructions: |
Author
The documentation for `meta.sourceProvenance` in `doc/stdenv/meta.chapter.md` says: "the `meta.sourceProvenance` attribute should be a list containing one or more value..." Let's update check-meta.nix to require that `meta.sourceProvenance` is a list, as the documentation says, rather than a single element. Adding two extra keystrokes `[` and `]` when filling out this field is an insignificant burden for package authors, and being able to assume that the `meta.sourceProvenance` field is always a list greatly simplifies any code that acts on the value of this field. Since `meta.sourceProvenance` was just merged a few hours ago now is the easiest time to fix this: nobody is using the feature yet.
Author
|
Rebased. |
gador
added a commit
to gador/nixpkgs
that referenced
this pull request
Jan 10, 2023
due to NixOS#175495 Signed-off-by: Florian Brandes <florian.brandes@posteo.de>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of changes
The documentation for
meta.sourceProvenanceindoc/stdenv/meta.chapter.mdsays: "themeta.sourceProvenanceattribute should be a list containing one or more value..."Let's update check-meta.nix to require that
meta.sourceProvenanceis a list, as the documentation says, rather than a single element.Adding two extra keystrokes
[and]when filling out this field is an insignificant burden for package authors, and being able to assume that themeta.sourceProvenancefield is always a list greatly simplifies any code that acts on the value of this field. For example, it simplifies thesourceProvenanceexample given incheck-meta.nix; the simplification is included in this PR.Since
meta.sourceProvenancewas just merged a few hours ago now is the easiest time to fix this: nobody is using the feature yet.Things done
sandbox = trueset innix.conf? (See Nix manual)nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage./result/bin/)nixos/doc/manual/md-to-db.shto update generated release notes