补丁

原因

这可能需要“预先”付出更多努力，但它为将来其他人节省的努力超过了它本身。这指的是读取补丁的其他发行版或上游维护者，或未来的 Gentoo 维护者。通过保持所有补丁“干净”，人们可以快速轻松地评估补丁，而无需搜索许多其他文件。

文件命名

您的补丁名称应该简明扼要。在执行文件列表时（例如，ls files/），当它们的文件名中包含良好的关键词时，扫描相关补丁会容易得多。

它还应该包含软件包名称及其针对其编写的版本。这样，搜索补丁或碰巧偶然发现文件本身的人就能了解其用途。剥离 ${PN}（以及在较小程度上，${PV}）会使文件名变得毫无用处。文件通常存储在 ${CATEGORY}/${PN}/files/ 中这一事实无关紧要，因为补丁可能在 Gentoo 之外使用。

方法

以下是对补丁标题中需要保留的内容的清单

• 外部链接
  • 上游邮件档案
  • 上游 bug 报告
  • 上游提交链接
  • 上游 ChangeLog 条目
  • Gentoo bug 报告
• 简短/中等解释
  • 为什么需要补丁？
  • 它修复了什么？
  • 为什么以这种方式修复它？
  • 未来改进修复的建议？
  • 它是一个权宜之计（解决方法）吗？
  • 如何进行回归测试？
  • 前后行为示例
    • 如何在没有补丁的情况下重现 bug
    • 如何在应用补丁后显示 bug 已修复
    • 也许上游以不同的方式修复了它，因此此测试可用于显示在使用更新版本时不再需要此补丁
• 状态
  • 它是否已在上游合并/拒绝/推迟/等？
  • 它是特定于发行版的吗？
• 归属
  • 谁发现了 bug？
  • 谁修复了 bug？
  • 谁编写了补丁？
  • 谁测试了补丁？
  • 谁对补丁提出了建议？

所有这些信息都应该在补丁本身中。它永远不应该在 ebuild 等内容中找到。如果您确实想在 ebuild 中的补丁旁边添加注释，那么这几乎是唯一可以接受的内容（其中 93671 是 Gentoo bug 编号）

PATCHES=(
	"${FILESDIR}"/${P}-dont-umask.patch #93671
)

在记录这些内容时，使用 RFC822/Git 样式标签来格式化元数据可能很有用。因此，在记录作者时，请使用

From: Nice Person <[email protected]>

或者，在记录相关 URL 时，请使用类似以下内容：

Bug: https://upstream.example.com/12345
Bug: https://bugs.gentoo.org/9889

如果您想记录您的版权签署，请添加 Signed-off-by 标签

Signed-off-by: Diligent Developer <[email protected]>

最后，你的补丁应该剔除所有无用的冗余信息。如果它不是直接从上游 SCM 获取的（例如 git format-patch 或 svn diff -r # 或 cvs diff -r 1.123 -r 1.124），那么元数据就是无用的。所以请删除它。这指的是生成补丁时使用的 diff 命令，或文件上的时间戳、本地版本信息或其他类似的垃圾信息。请注意，上下文信息（@@ 之后的内容）应该保留，因为在将补丁应用到更高版本时，它可能非常宝贵。例如

@@ -80,6 +82,7 @@ case $sys in
                  ^^^^^^^^^^^^ keep this part

如果你能使 ---/+++ 部分中的文件名保持一致且合理，则可获得额外加分。也就是说，删除不同的前导 backup/paths/ 和 .orig/.new 后缀。你的补丁应该采用 -p1 格式，因为这比任何其他 -p# 格式都要标准得多。它也是 eapply 默认理解的格式。一个好的建议是使用 a/ 和 b/（如 git format-patch 中所示）或包名/版本作为要删除的前导部分。

另请注意，patch 使用时间戳信息来自动删除空文件。或者，如果你想删除空文件，可以使用 eapply 的 -E 选项。

已删除的行不应该出现在补丁中，因为它们会被注释掉——只需完全删除它们即可。补丁通过在已删除行前添加 - 来显示它们，因此，简单地删除行而不是注释掉它们（这会增加噪音）并不会丢失任何信息。这使得补丁更短，更易读。

以下函数（适用于你的交互式 shell，而不是 ebuild）将帮助你删除这些内容

scrub_patch() {
	sed -i \
		-e '/^index /d' \
		-e '/^new file mode /d' \
		-e '/^Index:/d' \
		-e '/^=========/d' \
		-e '/^RCS file:/d' \
		-e '/^retrieving/d' \
		-e '/^diff/d' \
		-e '/^Files .* differ$/d' \
		-e '/^Only in /d' \
		-e '/^Common subdirectories/d' \
		-e '/^deleted file mode [0-9]*$/d' \
		-e '/^+++/s:\t.*::' \
		-e '/^---/s:\t.*::' \
		"$@"
}

scrub_patch some-patch-you-found.patch

示例

这展示了一个简单的解释和一个获取更多信息的 URL（不过，这个补丁可能需要一些署名）。运行 diff 命令生成的元数据（时间戳等）都不存在。

Fixes compilation in FreeBSD.
https://bugs.gentoo.org/138123

--- man-1.6d/gencat/genlib.c
+++ man-1.6d/gencat/genlib.c
@@ -54,7 +54,7 @@
 #include <unistd.h>
 #endif

-#ifndef __linux__
+#if !defined(__linux__) && !defined(__FreeBSD__)
 #include <memory.h>
 static int bcopy(src, dst, length)
 char *src, *dst;

Don't force umask to 022 or the -o umask option doesn't work.
Patch by Daniel Drake.
https://bugs.gentoo.org/93671

--- mount/mount.c
+++ mount/mount.c
@@ -1491,8 +1491,6 @@ main(int argc, char *argv[]) {
    if ((p = strrchr(progname, '/')) != NULL)
        progname = p+1;

-   umask(022);
-
    /* People report that a mount called from init without console
       writes error messages to /etc/mtab
       Let us try to avoid getting fd's 0,1,2 */

Don't let target flags bleed into build flags.
Fix by Bertrand Jacquin.
https://bugs.gentoo.org/226035

--- netem/Makefile
+++ netem/Makefile
@@ -2,6 +2,7 @@ DISTGEN = maketable normal pareto paretonormal
 DISTDATA = normal.dist pareto.dist paretonormal.dist experimental.dist

 HOSTCC ?= $(CC)
+CCOPTS  = $(CBUILD_CFLAGS)
 LDLIBS += -lm

 all: $(DISTGEN) $(DISTDATA)