nordic-dev.net/nixpkgs
nordic-dev.net/nixpkgs
2
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-22 15:03:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

CONTRIBUTING.md: patch conventions

Browse Source 
As discussed in the NixOS Security Discussion Matrix room at
https://matrix.to/#/!NBBFPbiuttRgTqbrcY:nixos.org/$kRB7R9ksae-78H4GQOO7NjMurKh7hSHimYSGMVE3w8k?via=nixos.org&via=matrix.org&via=nixos.dev and #317169

Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
This commit is contained in:
Arnout Engelen 2024-06-05 00:56:15 +02:00
parent 57610d2f8f
commit cbfd7ee395
No known key found for this signature in database
GPG Key ID: 061107B0F74A6DAA
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
pkgs/README.md
View File

@ -459,7 +459,10 @@ Examples going from bad to best practices:
## Patches
Patches available online should be retrieved using `fetchpatch`.
Sometimes, changes are needed to the source to allow building a derivation in nixpkgs, or to get earlier access to an upstream fix or improvement.
When using the `patches` parameter to `mkDerivation`, make sure the patch name clearly describes the reason for the patch, or add a comment.
Patches already merged upstream or published elsewhere should be retrieved using `fetchpatch`.
```nix
{
@ -473,7 +476,9 @@ Patches available online should be retrieved using `fetchpatch`.
}
```
Otherwise, you can add a `.patch` file to the `nixpkgs` repository. In the interest of keeping our maintenance burden to a minimum, only patches that are unique to `nixpkgs` should be added in this way.
Otherwise, you can add a `.patch` file to the `nixpkgs` repository.
In the interest of keeping our maintenance burden and the size of nixpkgs to a minimum, only do this for patches that are unique to `nixpkgs` or that have been proposed upstream but are not merged yet, cannot be easily fetched or have a high chance to disappear in the future due to unstable or unreliable URLs.
The latter avoids link rot when the upstream abandons, squashes or rebases their change, in which case the commit may get garbage-collected.
If a patch is available online but does not cleanly apply, it can be modified in some fixed ways by using additional optional arguments for `fetchpatch`. Check [the `fetchpatch` reference](https://nixos.org/manual/nixpkgs/unstable/#fetchpatch) for details.