如何提交patch 到内核-CSDN博客

转自：https://zhuanlan.zhihu.com/p/540500537

内核的开发是在邮件列表来进行的，通过一个个patch来更新内核，patch既是代码又是文档。我以提交的两个内核bug修正patch为例，来具体说明一下这个过程。

先同步本地内核源码，确保最新代码上还能复现对应的问题。阅读Documentation/process/submitting-pathes.rst 。代码规范需符合 coding-style.rst，Linux 的缩进使用的是TAB(8个空格)。

Commit message
尽量使用祈使语句，说明碰到了什么问题，处理措施是什么。

Subject: 对代码做了什么改变

如：“fix sparse/build warning” ，就不合适，不够准确。可以改成 “cast xx to __rcu pointer”，这个就明确地表明做了一个指针转换。

消息体里面主要是：说明问题，产生原因，解决方案三段式的结构，不要带主语。

如：不要说“I check xxx, We test xxx”，直接就是 check /test/fix/make/…… 。最后一般以“Introduce”语句作为结尾。例如:“Introduce a temporary value for “ima_rules” when iterating over the ruleset to avoid the deadlocks.”

最后面使用 Signed-off-by 来签名，表明这个patch的所有者。

The current IMA ruleset is identified by the variable "ima_rules"
that default to "&ima_default_rules". When loading a custom policy
for the first time, the variable is updated to "&ima_policy_rules"
instead. That update isn't RCU-safe, and deadlocks are possible.
Indeed, some functions like ima_match_policy() may loop indefinitely
when traversing "ima_default_rules" with list_for_each_entry_rcu().

When iterating over the default ruleset back to head, if the list
head is "ima_default_rules", and "ima_rules" have been updated to
"&ima_policy_rules", the loop condition (&entry->list != ima_rules)
stays always true, traversing won't terminate, causing a soft lockup
and RCU stalls.

Introduce a temporary value for "ima_rules" when iterating over
the ruleset to avoid the deadlocks.

Signed-off-by: your name <xxx@yyyy.com>

subject 里面还需要带上模块名，可以通过 git log xxx.c 来查找历史记录来确认正确的模块名。消息体格式不合格的话，模块的维护者不会合进去，他们也会给一些建议，提交者也要会使用 git log 这个工具来阅读历史记录，找一些模板来进行修改。

发送patch
生成patch文件 : git format-patch HEAD^1
检查patch文件 : scripts/checkpatch.pl xxx.patch
找到patch 的维护者 : scripts/get_maintainer.pl xxx.patch
这3个步骤完成后，我们有了patch文件和对应模块维护者，接下来就可以发送了。要注意配置邮件客户端（unicode，纯文本格式），直接把patch 贴上去，千万不要使用附件——邮件列表不支持html格式和附件。第一次发送可以使用 git send-email ，保证不会出错。Email 配置: 打开 ~/.gitconfig, 添加邮箱配置

[sendemail]
        smtpServer = smtp.mail.com
        smtpUser = usr@mail.com
        smtpServerPort = 25
        smtpPass = passwd
        smtpAuth = PLAIN

最后发送邮件，如:

git send-email --to=“Simon.THOBY@viveris.fr” --to=“zohar@linux.ibm.com”
–cc=“linux-kernel@vger.kernel.org” xxx.patch
最后是待发送的patch文件，patch 发送成功后，在https://patchwork.kernel.org 可以查看到。
在这里插入图片描述
其中这个message ID非常重要，更新patch 需要 –in-reply-to=＇ID＇。patch很难一次就被接受，中途会做多次修改，每次修改后，需要使用 in-replay-to 来回复上一次的 messag id 来把邮件关联到一起。接下来就是等待对方的回复。
在这里插入图片描述
针对patch的交流，可以使用邮件客户端（如：thunderbird），配置好格式（纯文件）就可以了，这样反复交流后，中途需要重新提交patch，注意要使用 in-reply-to来回复。如：

git send-email  --in-reply-to=20210824085747.23604-1-user@mail.com
--to=Simon.THOBY@viveris.fr  --to=zohar@linux.ibm.com   --cc=linux-
kernel@vger.kernel.org    xxx.patch

最终，如对方无疑义，会回复一个 Reviewed-By 的签名。这个签名表明已经有一个模块维护者审核通过了。
在这里插入图片描述
如果，patch还需要做最后的修改，则可以把这个签名加进去。

接下来 patch 会进入 next 仓库，会有一个窗口期进行合并，这期间会做几次自动化测试，有状况的话，会收到来自 robot 的邮件.

按照邮件的指示，修改patch直到本地测试通过，然后，再次提交patch，添加Report-by的签名，自动化测试通过后，模块的负责人会进行签名（Singed-off-by:）。
在这里插入图片描述

有了这两个签名后，这个patch 就可以合入主线了，接下来，就是等待合并的窗口期，直到收到下面的邮件
在这里插入图片描述
表明patch 已经进入了 queue-5.15 仓库，最后一步就是合入 5.15主线，不出意外的话，后面不会再有邮件，等5.15发布后，更新主线代码，应该就能看到这个patch了。可以使用 git log --author=xxx@mail.com 来查找patch.
有几个注意事项
1：重新提交的patch的时候，需要使用 git format-patch -v2 xxx来生成patch, 并在message 里面加上v2版本的变化——.
在这里插入图片描述
依次类推，可生成v3,v4,vn版本的patch。

2：提交patch前，先在本地做一个 sparse测试，以免后面被打回。

3：patch其实没有很明确的状态，也有可能几个星期后，直接就合入了，如果长期（2个月左右吧）没有回应的话，可以更新代码，重新提交patch看看，有可能被别人修正了，也有可能遗漏了。

4：尽量一个功能一个patch，如：修正了某个问题，有新的优化方案，那就需要2个patch: 一个先修正问题，一个是新的优化方案。

5: 如果patchwork里面找不到patch，可以在网站 https://lore.kernel.org/ 用邮件名进行搜索，找回message id.

稳定版本patch

http://git.kernel.org 里面有各种内核树，Linus 维护的内核称之为“上游内核”也就是主线，还有一个稳定版本内核线，也就是长期支持的内核版本。

upstream： /pub/scm/linux/kernel/git/torvalds/linux.git
stable： /pub/scm/linux/kernel/git/stable/linux.git
稳定版本内核对patch的要求较严格，只接受bug修复，代码量要少，能看得懂的代码。详见：Documentation/process/stable-kernel-rules.rst

Subject 需要加上 [STABLE]，或者 [version STABLE]

[STABLE] mm: fix dereference a null pointer in migrate

	[4.19 STABLE]mm: fix dereference a null pointer in migrate

Message的第一行是“上游的commit id号”，签名栏增加“Cc: stable@vger.kernel.org # linux-verision”。有时候，由于上游内核变化很大，patch不适用于上游代码，因此没有id号——
在这里插入图片描述
# linux-4.19.y 是指定内核版本，也可以不指定。最简单的办法是提交到upstream的时候，Cc: stable@vger.kernel.org ，会自动提交到稳定版本。

提取某个版本的内核：

git fetch origin refs/tags/v4.19:refs/tags/v4.19
git checkout v4.19 -b v4.19
邮件订阅
发送邮件的格式要求： unicode编码和text格式。基本的命令是：

subscribe xxx ：请求订阅xxx模块。
auth xxx subscribe xxx xxx：根据服务器的回复进行认证。
unsubscribe xxx：退订某个模块。
订阅内核模块
发送“subscribe linux-kernel”到 majordomo@vger.kernel.org。邮件服务器自动解析请求，不解析标题，标题可以为空。正常的话，服务器会返回消息，提示已收到请求，需要再发送认证邮件，并给出认证码。直接回复邮件，发送 “auth xxx subscribe linux-kernel xxxx”，最后会收到一封成功订阅的邮件，它里面有退订的命令，邮件末尾有一些历史邮件列表的档案，建议收藏。

内核模块每天的邮件量较大，可以设定关键字进行过滤，然后，一目十行地看看标题，有兴趣的就进去看看。或者，只订阅某个子模块，在线查看内核的邮件列表。

http://lkml.iu.edu/hypermail/linux/kernel/index.html 邮件列表 (镜像)
Majordomo Lists at VGER.KERNEL.ORG : 邮件列表 (官网)
The linux-kernel mailing list FAQ : 邮件列表 FAQ
订阅其它子模块的流程类似，具体命令查看vger邮件列表网站。

邮箱账号
并不是所有的邮箱账号都可以订阅，服务器有一定的要求，测试下来，outlook, yahoo, 163, qq，aliyun好像都不行。gmail和 icloud可以，还有就是幸运地发现 tom邮箱非常地好用。、

欢迎大家来我的公众号交流: 般若程序蝉

编辑于 2022-07-12 10:25