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

Don't require a patch comment when the patch is a local file #117

Open
roberth opened this issue Jul 14, 2021 · 1 comment
Open

Don't require a patch comment when the patch is a local file #117

roberth opened this issue Jul 14, 2021 · 1 comment

Comments

@roberth
Copy link

roberth commented Jul 14, 2021

We correctly ask for patches to come with a comment because we prefer to fetch them and we have no other place to provide context for the patch. See also https://github.com/jtojnar/nixpkgs-hammering/blob/master/explanations/missing-patch-comment.md

However, when the a patch is a local file, because it is not upstreamable, we have plenty of control and the file name or embedded message can cover all there is to know. See NixOS/nixpkgs#130102 (comment)

I would like to avoid a situation where we have nonsense commits and nonsense comments littering Nixpkgs, so I suggest we don't report missing comments when the patch is a path expression.

@jtojnar
Copy link
Owner

jtojnar commented Jul 15, 2021

I do agree that in trivial cases like that a comment is unnecessary as it just duplicates the patch name.

However, there are cases where the that will not be enough. Example: https://github.com/NixOS/nixpkgs/blob/90cbe95037ff727540691436c7f8532ac602b376/pkgs/development/tools/build-managers/meson/default.nix#L19-L60

I prefer that a summary comments are in the Nix file so that the person updating the package can quickly guess if the file is still needed (after reading the release notes). The patch itself can contain more detailed description.

So I would prefer not to remove the check but rather reformulate the message such that it is clearer it is just a suggestion and viewer discretion is advised. For instance, we could add examples where comment would be pointless to the explanation.

Related: #27

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

No branches or pull requests

2 participants