Warning

此文件的目的是为让中文读者更容易阅读和理解,而不是作为一个分支。 因此, 如果您对此文件有任何意见或更新,请先尝试更新原始英文文件。

Note

如果您发现本文档与原始文件有任何不同或者有翻译问题,请联系该文件的译者, 或者请求时奎亮的帮助:<alexs@kernel.org>。

Original:Creating Pull Requests
译者:吴想成 Wu XiangCheng <bobwxc@email.cn>

如何创建拉取请求

本章描述维护人员如何创建并向其他维护人员提交拉取请求。这对将更改从一个维护者 树转移到另一个维护者树非常有用。

本文档由Tobin C. Harding(当时他尚不是一名经验丰富的维护人员)编写,内容主要 来自Greg Kroah Hartman和Linus Torvalds在LKML上的评论。Jonathan Corbet和Mauro Carvalho Chehab提出了一些建议和修改。错误不可避免,如有问题,请找Tobin C. Harding <me@tobin.cc>。

原始邮件线程:

http://lkml.kernel.org/r/20171114110500.GA21175@kroah.com

创建分支

首先,您需要将希望包含拉取请求里的所有更改都放在单独分支中。通常您将基于某开发 人员树的一个分支,一般是打算向其发送拉取请求的开发人员。

为了创建拉取请求,您必须首先标记刚刚创建的分支。建议您选择一个有意义的标记名, 以即使过了一段时间您和他人仍能理解的方式。在名称中包含源子系统和目标内核版本 的指示也是一个好的做法。

Greg提供了以下内容。对于一个含有drivers/char中混杂事项、将应用于4.15-rc1内核的 拉取请求,可以命名为 char-misc-4.15-rc1 。如果要在 char-misc-next 分支 上打上此标记,您可以使用以下命令:

git tag -s char-misc-4.15-rc1 char-misc-next

这将在 char-misc-next 分支的最后一个提交上创建一个名为 char-misc-4.15-rc1 的标记,并用您的gpg密钥签名(参见 Configure Git )。

Linus只接受基于签名过的标记的拉取请求。其他维护者可能会有所不同。

当您运行上述命令时 git 会打开编辑器要求你描述一下这个标记。在本例中您需要 描述拉取请求,所以请概述一下包含的内容,为什么要合并,是否完成任何测试。所有 这些信息都将留在标记中,然后在维护者合并拉取请求时保留在合并提交中。所以把它 写好,它将永远留在内核中。

正如Linus所说:

不管怎么样,至少对我来说,重要的是 *信息* 。我需要知道我在拉取什么、
为什么我要拉取。我也希望将此消息用于合并消息,因此它不仅应该对我有
意义,也应该可以成为一个有意义的历史记录。

注意,如果拉取请求有一些不寻常的地方,请详细说明。如果你修改了并非
由你维护的文件,请解释 **为什么** 。我总会在差异中看到的,如果你不
提的话,我只会觉得分外可疑。当你在合并窗口后给我发新东西的时候,
(甚至是比较重大的错误修复),不仅需要解释做了什么、为什么这么做,
还请解释一下 **时间问题** 。为什么错过了合并窗口……

我会看你写在拉取请求邮件和签名标记里面的内容,所以根据你的工作流,
你可以在签名标记里面描述工作内容(也会自动放进拉取请求邮件),也
可以只在标记里面放个占位符,稍后在你实际发给我拉取请求时描述工作内容。

是的,我会编辑这些消息。部分因为我需要做一些琐碎的格式调整(整体缩进、
括号等),也因为此消息可能对我有意义(描述了冲突或一些个人问题)而对
合并提交信息上下文没啥意义,因此我需要尽力让它有意义起来。我也会
修复一些拼写和语法错误,特别是非母语者(母语者也是;^)。但我也会删掉
或增加一些内容。

                Linus

Greg给出了一个拉取请求的例子:

Char/Misc patches for 4.15-rc1

Here is the big char/misc patch set for the 4.15-rc1 merge window.
Contained in here is the normal set of new functions added to all
of these crazy drivers, as well as the following brand new
subsystems:
        - time_travel_controller: Finally a set of drivers for the
          latest time travel bus architecture that provides i/o to
          the CPU before it asked for it, allowing uninterrupted
          processing
        - relativity_shifters: due to the affect that the
          time_travel_controllers have on the overall system, there
          was a need for a new set of relativity shifter drivers to
          accommodate the newly formed black holes that would
          threaten to suck CPUs into them.  This subsystem handles
          this in a way to successfully neutralize the problems.
          There is a Kconfig option to force these to be enabled
          when needed, so problems should not occur.

All of these patches have been successfully tested in the latest
linux-next releases, and the original problems that it found have
all been resolved (apologies to anyone living near Canberra for the
lack of the Kconfig options in the earlier versions of the
linux-next tree creations.)

Signed-off-by: Your-name-here <your_email@domain>

此标记消息格式就像一个git提交。顶部有一行“总结标题”, 一定要在下面sign-off。

现在您已经有了一个本地签名标记,您需要将它推送到可以被拉取的位置:

git push origin char-misc-4.15-rc1

创建拉取请求

最后要做的是创建拉取请求消息。可以使用 git request-pull 命令让 git 为你做这件事,但它需要确定你想拉取什么,以及拉取针对的基础(显示正确的拉取 更改和变更状态)。以下命令将生成一个拉取请求:

git request-pull master git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/char-misc.git/ char-misc-4.15-rc1

引用Greg的话:

此命令要求git比较从“char-misc-4.15-rc1”标记位置到“master”分支头(上述
例子中指向了我从Linus的树分叉的地方,通常是-rc发布)的差异,并去使用
git:// 协议拉取。如果你希望使用 https:// 协议,也可以用在这里(但是请
注意,部分人由于防火墙问题没法用https协议拉取)。

如果char-misc-4.15-rc1标记没有出现在我要求拉取的仓库中,git会提醒
它不在那里,所以记得推送到公开地方。

“git request-pull”会包含git树的地址和需要拉取的特定标记,以及标记
描述全文(详尽描述标记)。同时它也会创建此拉取请求的差异状态和单个
提交的缩短日志。

Linus回复说他倾向于 git:// 协议。其他维护者可能有不同的偏好。另外,请注意 如果你创建的拉取请求没有签名标记, https:// 可能是更好的选择。完整的讨论 请看原邮件。

提交拉取请求

拉取请求的提交方式与普通补丁相同。向维护人员发送内联电子邮件并抄送LKML以及 任何必要特定子系统的列表。对Linus的拉取请求通常有如下主题行:

[GIT PULL] <subsystem> changes for v4.15-rc1