Skip to content

Commit 406ea5c

Browse files
marcin-serwinalyssais
authored andcommitted
CONTRIBUTING: allow fetching unaccepted changes if the URL is stable
Reword documentation to allow using `fetchpatch` for changes that are not yet merged upstream. Additionally, put a greater emphasis on URL stability. fixes #400873
1 parent 8d21d16 commit 406ea5c

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

pkgs/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,7 @@ In the interest of keeping our maintenance burden and the size of Nixpkgs to a m
508508
patches = [
509509
(fetchpatch {
510510
name = "fix-check-for-using-shared-freetype-lib.patch";
511-
url = "http://git.ghostscript.com/?p=ghostpdl.git;a=patch;h=8f5d285";
511+
url = "https://cgit.ghostscript.com/cgi-bin/cgit.cgi/ghostpdl.git/patch/?id=8f5d28536e4518716fdfe974e580194c8f57871d";
512512
hash = "sha256-uRcxaCjd+WAuGrXOmGfFeu79cUILwkRdBu48mwcBE7g=";
513513
})
514514
];
@@ -517,12 +517,13 @@ In the interest of keeping our maintenance burden and the size of Nixpkgs to a m
517517

518518
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.
519519

520+
When adding patches in this manner you should be reasonably sure that the used URL is stable. Patches referencing open pull requests will change when the PR is updated and code forges (such as GitHub) usually garbage collect commits that are no longer reachable due to rebases/amends.
521+
520522
### Vendoring patches
521523

522524
In the following cases, a `.patch` file _should_ be added to Nixpkgs repository, instead of retrieved:
523525

524526
- solves problems unique to packaging in Nixpkgs
525-
- is already proposed upstream but not merged yet
526527
- cannot be fetched easily
527528
- has a high chance to disappear in the future due to unstable or unreliable URLs
528529

0 commit comments

Comments
 (0)