From 18cd14175f42069f315f0a0017a0589bfcda1198 Mon Sep 17 00:00:00 2001 From: Stefan Frijters Date: Fri, 28 May 2021 11:55:21 +0200 Subject: [PATCH] doc/coding-conventions: Add documentation for fetchpatch optional arguments (cherry picked from commit 585f63b364460b11a25f1692678395465a8fe8b4) --- doc/contributing/coding-conventions.chapter.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/contributing/coding-conventions.chapter.md b/doc/contributing/coding-conventions.chapter.md index 6076460b893..6516172adde 100644 --- a/doc/contributing/coding-conventions.chapter.md +++ b/doc/contributing/coding-conventions.chapter.md @@ -526,6 +526,16 @@ If you do need to do create this sort of patch file, one way to do so is with gi $ git diff > nixpkgs/pkgs/the/package/0001-changes.patch ``` +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`: + +- `stripLen`: Remove the first `stripLen` components of pathnames in the patch. +- `extraPrefix`: Prefix pathnames by this string. +- `excludes`: Exclude files matching this pattern. +- `includes`: Include only files matching this pattern. +- `revert`: Revert the patch. + +Note that because the checksum is computed after applying these effects, using or modifying these arguments will have no effect unless the `sha256` argument is changed as well. + ## Package tests {#sec-package-tests} Tests are important to ensure quality and make reviews and automatic updates easy.