Documentation/translations/zh_CN/process/5.Posting.rst

   1 .. include:: ../disclaimer-zh_CN.rst
   2
   3 :Original: :ref:`Documentation/process/5.Posting.rst <development_posting>`
   4 :Translator: Alex Shi <alex.shi@linux.alibaba.com>
   5
   6 .. _cn_development_posting:
   7
   8 发送补丁
   9 ========
  10
  11 迟早，当您的工作准备好提交给社区进行审查，并最终包含到主线内核中时。不出所料，
  12 内核开发社区已经发展出一套用于发布补丁的约定和过程；遵循这些约定和过程将使
  13 参与其中的每个人的生活更加轻松。本文件将试图合理详细地涵盖这些期望；更多信息
  14 也可在以下文件中找到
  15 :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`,
  16 :ref:`Documentation/process/submitting-drivers.rst  <submittingdrivers>`
  17 和 :ref:`Documentation/translations/zh_CN/process/submit-checklist.rst <cn_submitchecklist>`.
  18
  19 何时邮寄
  20 --------
  21
  22 在补丁完全“准备好”之前，有一个不断的诱惑来避免发布补丁。对于简单的补丁，
  23 这不是问题。但是，如果正在完成的工作很复杂，那么在工作完成之前从社区获得
  24 反馈就可以获得很多好处。因此，您应该考虑发布正在进行的工作，甚至使Git树
  25 可用，以便感兴趣的开发人员可以随时赶上您的工作。
  26
  27 当发布还没有准备好包含的代码时，最好在发布本身中这样说。还应提及任何有待完成
  28 的主要工作和任何已知问题。很少有人会看到那些被认为是半生不熟的补丁，但是那些
  29 人会想到他们可以帮助你把工作推向正确的方向。
  30
  31 创建补丁之前
  32 ------------
  33
  34 在考虑将补丁发送到开发社区之前，有许多事情应该做。这些包括：
  35
  36  - 尽可能地测试代码。利用内核的调试工具，确保内核使用所有合理的配置选项组合
  37    进行构建，使用跨编译器为不同的体系结构进行构建等。
  38
  39  - 确保您的代码符合内核编码风格指南。
  40
  41  - 您的更改是否具有性能影响？如果是这样，您应该运行基准测试来显示您的变更的
  42    影响（或好处）；结果的摘要应该包含在补丁中。
  43
  44  - 确保您有权发布代码。如果这项工作是为雇主完成的，雇主对这项工作具有所有权，
  45    并且必须同意根据GPL对其进行放行。
  46
  47 一般来说，在发布代码之前进行一些额外的思考，几乎总是能在短时间内得到回报。
  48
  49 补丁准备
  50 --------
  51
  52 准备发布补丁可能是一个惊人的工作量，但再次尝试节省时间在这里通常是不明智的，
  53 即使在短期内。
  54
  55 必须针对内核的特定版本准备补丁。作为一般规则，补丁程序应该基于Linus的Git树中
  56 的当前主线。当以主线为基础时，从一个众所周知的发布点开始——一个稳定的或RC的
  57 发布——而不是在一个主线分支任意点。
  58
  59 但是，可能需要针对-mm、linux-next或子系统树生成版本，以便于更广泛的测试和审查。
  60 根据补丁的区域以及其他地方的情况，针对这些其他树建立补丁可能需要大量的工作来
  61 解决冲突和处理API更改。
  62
  63 只有最简单的更改才应格式化为单个补丁；其他所有更改都应作为一系列逻辑更改进行。
  64 分割补丁是一门艺术；一些开发人员花了很长时间来弄清楚如何按照社区期望的方式来
  65 做。然而，有一些经验法则可以大大帮助：
  66
  67  - 您发布的补丁程序系列几乎肯定不会是工作系统中的一系列更改。相反，您所做的
  68    更改需要在最终形式中加以考虑，然后以有意义的方式进行拆分。开发人员对离散的、
  69    自包含的更改感兴趣，而不是您获取这些更改的路径。
  70
  71  - 每个逻辑上独立的变更都应该格式化为单独的补丁。这些更改可以是小的（“向此
  72    结构添加字段”）或大的（例如，添加一个重要的新驱动程序），但它们在概念上
  73    应该是小的，并且可以接受一行描述。每个补丁都应该做一个特定的更改，可以单独
  74    检查并验证它所做的事情。
  75
  76  - 作为重申上述准则的一种方法：不要在同一补丁中混合不同类型的更改。如果一个
  77    补丁修复了一个关键的安全漏洞，重新排列了一些结构，并重新格式化了代码，那么
  78    很有可能它会被忽略，而重要的修复将丢失。
  79
  80  - 每个补丁都应该产生一个内核，它可以正确地构建和运行；如果补丁系列在中间被
  81    中断，那么结果应该仍然是一个工作的内核。补丁系列的部分应用是使用
  82    “git bisct”工具查找回归的一个常见场景；如果结果是一个损坏的内核，那么对于
  83    那些从事追踪问题的高尚工作的开发人员和用户来说，将使他们的生活更加艰难。
  84
  85  - 不过，不要过分。一位开发人员曾经将一组编辑内容作为500个单独的补丁发布到一个
  86    文件中，这并没有使他成为内核邮件列表中最受欢迎的人。一个补丁可以相当大，
  87    只要它仍然包含一个单一的逻辑变更。
  88
  89  - 用一系列补丁添加一个全新的基础设施是很有诱惑力的，但是在系列中的最后一个
  90    补丁启用整个补丁之前，该基础设施是不使用的。如果可能的话，应该避免这种
  91    诱惑；如果这个系列增加了回归，那么二分法将指出最后一个补丁是导致问题的
  92    补丁，即使真正的bug在其他地方。只要有可能，添加新代码的补丁程序应该立即
  93    激活该代码。
  94
  95 创建完美补丁系列的工作可能是一个令人沮丧的过程，在完成“真正的工作”之后需要花费
  96 大量的时间和思考。但是，如果做得好，这是一段很好的时间。
  97
  98 补丁格式和更改日志
  99 ------------------
 100
 101 所以现在你有了一系列完美的补丁可以发布，但是这项工作还没有完成。每个补丁都
 102 需要被格式化成一条消息，它可以快速而清晰地将其目的传达给世界其他地方。为此，
 103 每个补丁将由以下部分组成：
 104
 105  - 命名补丁作者的可选“from”行。只有当你通过电子邮件传递别人的补丁时，这一行
 106    才是必要的，但是如果有疑问，添加它不会有任何伤害。
 107
 108  - 一行描述补丁的作用。对于没有其他上下文的读者来说，此消息应该足够了解补丁
 109    的范围；这是将在“短格式”变更日志中显示的行。此消息通常首先用相关的子系统
 110    名称格式化，然后是补丁的目的。例如：
 111
 112     ::
 113
 114         gpio: fix build on CONFIG_GPIO_SYSFS=n
 115
 116  - 一个空白行，后面是补丁内容的详细描述。这个描述可以是必需的；它应该说明补丁
 117    的作用以及为什么它应该应用于内核。
 118
 119  - 一个或多个标记行，至少有一个由补丁作者的：signed-off-by 签名。签名将在下面
 120    更详细地描述。
 121
 122 上面的项目一起构成补丁的变更日志。写一篇好的变更日志是一门至关重要但常常被
 123 忽视的艺术；值得花一点时间来讨论这个问题。当你写一个变更日志时，你应该记住
 124 有很多不同的人会读你的话。其中包括子系统维护人员和审查人员，他们需要决定是否
 125 应该包括补丁，分销商和其他维护人员试图决定是否应该将补丁反向移植到其他内核，
 126 bug搜寻人员想知道补丁是否负责他们正在追查的问题，想知道内核如何变化的用户。
 127 等等。一个好的变更日志以最直接和最简洁的方式向所有这些人传达所需的信息。
 128
 129 为此，总结行应该描述变更的影响和动机，以及在一行约束条件下可能发生的变化。
 130 然后，详细的描述可以详述这些主题，并提供任何需要的附加信息。如果补丁修复了
 131 一个bug，请引用引入该bug的commit（如果可能，请在引用commits时同时提供commit id
 132 和标题）。如果某个问题与特定的日志或编译器输出相关联，请包含该输出以帮助其他
 133 人搜索同一问题的解决方案。如果更改是为了支持以后补丁中的其他更改，那么就这么
 134 说。如果更改了内部API，请详细说明这些更改以及其他开发人员应该如何响应。一般
 135 来说，你越能把自己放在每个阅读你的changelog的人的位置上，changelog（和内核
 136 作为一个整体）就越好。
 137
 138 不用说，变更日志应该是将变更提交到修订控制系统时使用的文本。接下来是：
 139
 140  - 补丁本身，采用统一的（“-u”）补丁格式。将“-p”选项用于diff将使函数名与更改
 141    相关联，从而使结果补丁更容易被其他人读取。
 142
 143 您应该避免在补丁中包括对不相关文件（例如，由构建过程生成的文件或编辑器
 144 备份文件）的更改。文档目录中的文件“dontdiff”在这方面有帮助；使用“-X”选项将
 145 其传递给diff。
 146
 147 上面提到的标签用于描述各种开发人员如何与这个补丁的开发相关联。
 148 :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`
 149 文档中对它们进行了详细描述；下面是一个简短的总结。每一行的格式如下：
 150
 151 ::
 152
 153         tag: Full Name <email address>  optional-other-stuff
 154
 155 常用的标签有：
 156
 157  - Signed-off-by: 这是一个开发人员的证明，他或她有权提交补丁以包含到内核中。
 158    这是开发来源认证协议，其全文可在
 159    :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`
 160    中找到，如果没有适当的签字，则不能合并到主线中。
 161
 162  - Co-developed-by: 声明补丁是由多个开发人员共同创建的；当几个人在一个补丁上
 163    工作时，它用于将属性赋予共同作者（除了 From: 所赋予的作者之外）。因为
 164    Co-developed-by: 表示作者身份，所以每个共同开发人, 必须紧跟在相关合作作者
 165    的签名之后。具体内容和示例可以在以下文件中找到
 166    :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`
 167
 168  - Acked-by: 表示另一个开发人员（通常是相关代码的维护人员）同意补丁适合包含
 169    在内核中。
 170
 171  - Tested-by: 声明指定的人已经测试了补丁并发现它可以工作。
 172
 173  - Reviewed-by: 指定的开发人员已经审查了补丁的正确性；有关详细信息，请参阅
 174    :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`
 175
 176  - Reported-by: 指定报告此补丁修复的问题的用户；此标记用于提供感谢。
 177
 178  - Cc：指定的人收到了补丁的副本，并有机会对此发表评论。
 179
 180 在补丁中添加标签时要小心：只有cc:才适合在没有指定人员明确许可的情况下添加。
 181
 182 发送补丁
 183 --------
 184
 185 在邮寄补丁之前，您还需要注意以下几点：
 186
 187  - 您确定您的邮件发送程序不会损坏补丁吗？有免费的空白更改或由邮件客户端
 188    执行的行包装的补丁不会在另一端复原，并且通常不会进行任何详细检查。如果有
 189    任何疑问，把补丁寄给你自己，让你自己相信它是完好无损的。
 190
 191    :ref:`Documentation/translations/zh_CN/process/email-clients.rst <cn_email_clients>`
 192    提供了一些有用的提示，可以让特定的邮件客户机工作以发送补丁。
 193
 194  - 你确定你的补丁没有愚蠢的错误吗？您应该始终通过scripts/checkpatch.pl运行
 195    补丁程序，并解决它提出的投诉。请记住，checkpatch.pl虽然是大量思考内核
 196    补丁应该是什么样子的体现，但它并不比您聪明。如果修复checkpatch.pl投诉会
 197    使代码变得更糟，请不要这样做。
 198
 199 补丁应始终以纯文本形式发送。请不要将它们作为附件发送；这使得审阅者在答复中更难
 200 引用补丁的部分。相反，只需将补丁直接放到您的消息中。
 201
 202 邮寄补丁时，重要的是将副本发送给任何可能感兴趣的人。与其他一些项目不同，内核
 203 鼓励人们错误地发送过多的副本；不要假定相关人员会看到您在邮件列表中的发布。
 204 尤其是，副本应发送至：
 205
 206  - 受影响子系统的维护人员。如前所述，维护人员文件是查找这些人员的第一个地方。
 207
 208  - 其他在同一领域工作的开发人员，尤其是那些现在可能在那里工作的开发人员。使用
 209    git查看还有谁修改了您正在处理的文件，这很有帮助。
 210
 211  - 如果您对错误报告或功能请求做出响应，也可以抄送原始发送人。
 212
 213  - 将副本发送到相关邮件列表，或者，如果没有其他应用，则发送到Linux内核列表。
 214
 215  - 如果您正在修复一个bug，请考虑该修复是否应进入下一个稳定更新。如果是这样，
 216    stable@vger.kernel.org 应该得到补丁的副本。另外，在补丁本身的标签中添加
 217    一个“cc:stable@vger.kernel.org”；这将使稳定团队在修复进入主线时收到通知。
 218
 219 当为一个补丁选择接收者时，最好知道你认为谁最终会接受这个补丁并将其合并。虽然
 220 可以将补丁直接发送给LinusTorvalds并让他合并，但通常情况下不会这样做。Linus
 221 很忙，并且有子系统维护人员负责监视内核的特定部分。通常您会希望维护人员合并您
 222 的补丁。如果没有明显的维护人员，Andrew Morton通常是最后的补丁目标。
 223
 224 补丁需要好的主题行。补丁程序行的规范格式如下：
 225
 226 ::
 227
 228         [PATCH nn/mm] subsys: one-line description of the patch
 229
 230 其中“nn”是补丁的序号，“mm”是系列中补丁的总数，“subsys”是受影响子系统的名称。
 231 显然，一个单独的补丁可以省略nn/mm。
 232
 233 如果您有一系列重要的补丁，那么通常将介绍性描述作为零部分发送。不过，这种约定
 234 并没有得到普遍遵循；如果您使用它，请记住简介中的信息不会使它进入内核变更日志。
 235 因此，请确保补丁本身具有完整的变更日志信息。
 236
 237 一般来说，多部分补丁的第二部分和后续部分应作为对第一部分的回复发送，以便它们
 238 在接收端都连接在一起。像git和coilt这样的工具有命令，可以通过适当的线程发送
 239 一组补丁。但是，如果您有一个长系列，并且正在使用git，请远离–chain reply-to
 240 选项，以避免创建异常深的嵌套。