Git 中的 Sign Off 功能有什么用？

Question

Git 中的 Sign Off 功能有什么意义？

git commit --signoff

我应该什么时候使用它，如果有的话？

Answer 1

Sign-off 是在 Linux 内核和一些其他项目中获取补丁的必要条件，但大多数项目实际上并不使用它。

它是在SCO 诉讼之后引入的（以及 SCO的其他版权侵权指控，其中大部分他们从未真正上过法庭），作为开发者原产地证书。 它用于表示您证明您已经创建了有问题的补丁，或者您证明据您所知，它是在适当的开源许可下创建的，或者它是由某人提供给您的否则根据这些条款。 这可以帮助建立一个负责相关代码版权状态的人员链，以帮助确保未在适当的自由软件（开源）许可下发布的受版权保护的代码不包含在内核中。

Answer 2

Sign-off 是提交消息末尾的一行，用于证明谁是提交的作者。 它的主要目的是改进对谁做了什么的跟踪，尤其是补丁。

示例提交：

Add tests for the payment processor.

Signed-off-by: Humpty Dumpty <humpty.dumpty@example.com>

如果用于开源项目，它应该包含用户真实姓名。

如果分支维护者需要稍微修改补丁以合并它们，他可以要求提交者重新比较，但这会适得其反。 他可以调整代码并将他的签名放在最后，这样原作者仍然可以获得补丁的功劳。

Add tests for the payment processor.

Signed-off-by: Humpty Dumpty <humpty.dumpty@example.com>

[Project Maintainer: Renamed test methods according to naming convention.]
Signed-off-by: Project Maintainer <project.maintainer@example.com>

来源：http: //gerrit.googlecode.com/svn/documentation/2.0/user-signedoffby.html

Answer 3

TLDR； 通常证明提交者有权在同一许可下提交此作品并同意开发者原产地证书（有关更多信息，请参见http://developercertificate.org/ ）。

---

Git 2.7.1（2016 年 2 月）在David A. Wheeler ( david-a-wheeler )的提交 b2c150d （2016 年 1 月 5 日）中阐明了这一点。
^{（由Junio C Hamano -- gitster --在提交 7aae9ba中合并，2016 年 2 月 5 日）}

git commit手册页现在包括：

-s::
--signoff::

在提交日志消息的末尾添加由提交Signed-off-by行。
签核的含义取决于项目，但它通常证明提交者有权在相同的许可下提交此作品并同意开发者原产地证书（有关更多信息，请参阅https://developercertificate.org ）。

---

展开描述--signoff文档

修改各种文档（手册页）文件以更详细地解释--signoff含义。

这受到“ lwn 文章 'Bottomley: DCO 的适度提议' ”（开发者原产地证书）的启发，其中 paulj 指出：

我对 DCO 的问题是，在git commit 中添加“ -s ”参数并不意味着您甚至听说过 DCO （ git commit手册页在任何地方都没有提到 DCO ），没关系实际看到它。

那么，“ signed-off-by ”的存在如何以任何方式暗示发件人同意并承诺 DCO？ 结合事实，我在没有 SOB 的补丁列表上看到了回复，这些回复无非是“重新发送并signed-off-by以便我可以提交它”。

扩展 git 的文档将更容易证明开发人员在使用--signoff时理解了它。

---

请注意，此签核现在（对于 Git 2.15.x/2.16，2018 年第一季度）也可用于git pull 。

请参阅W. Trevor King ( wking )的提交 3a4d2c7 （2017 年 10 月 12 日）。
^{（由Junio C Hamano -- gitster --在提交 fb4cd88中合并，2017 年 11 月 6 日）}

pull ：将--signoff/--no-signoff传递给“ git merge ”

merge 可以带--signoff ，但是没有 pull 传递--signoff下来，使用起来很不方便； 允许“ pull ”选择并通过它。

---

在 Git 2.33（2021 年第三季度）中， SubmitingPatches文档进一步（重新）说明了signoff核背后的意图：DCO（ 对于开源项目，首选CLA）。

请参阅Ævar Arnfjörð Bjarmason ( avar )的提交 f003a91和提交 4523dc8 （2021 年 7 月 22 日）。
^{（由Junio C Hamano -- gitster --在提交 58705b4中合并，2021 年 8 月 4 日）}

SubmittingPatches : 将 Signed-off-by 的讨论移到“send”之上

^{签字人：Ævar Arnfjörð Bjarmason}

将讨论添加 SOB 预告片的部分移到讨论生成补丁本身的部分上方。
这是有道理的，因为我们不希望有人经历“ git format-patch ” ^{（ man ）}的过程，只是后来才意识到他们应该使用“ git commit -s ” ^{（ man ）}或等效的。

SubmittingPatches现在包含在其手册页中：

[[搁笔]]

通过添加您的Signed-off-by预告片来证明您的工作

为了更好地跟踪谁做了什么，我们要求您通过“签署”您的补丁来证明您编写了补丁或有权在与我们相同的许可下传递它。 未经签字，我们不能接受您的补丁。

如果（且仅当）您证明以下 DCO：

[[dco]]

.开发商原产地证书 1.1

---

请注意，GitHub 可以强制您（自 2022 年 6 月起）向您的提交消息添加签核：

管理员可以要求签署基于 Web 的提交

组织所有者和存储库管理员现在可以要求开发人员签署通过 GitHub 的 Web 界面所做的提交，例如在编辑文件或合并拉取请求时。

此外，开发人员现在可以更轻松地在 Web 界面中完成签核，从而减少被阻止合并的提交，并减少解决被阻止提交所花费的时间。

启用该设置后，网页界面会通知开发者，他们的提交动作也将构成签核，如下图所示。
就像在命令行上使用 Git 的--signoff选项一样，在 Web 界面中签名会自动将Signed-off-by:文本附加到提交消息中。

Answer 4

这个问题有一些很好的答案。 我将尝试添加一个更广泛的答案，即关于这些类型的行/标题/预告片在当前实践中的含义。 尤其是签核头（它不是唯一的）。

在 Git 和 Linux 等项目的当前实践中，像“sign-off”（↑2）这样的标头或尾标（↑1）是提交的有效结构化元数据。 这些都附加到提交消息的末尾，在消息正文的“自由形式”（非结构化）部分之后。 这些是标记-值（或键-值）对，通常由冒号和空格 ( :␣ ) 分隔。

就像我提到的，“签收”并不是当前实践中唯一的预告片。 例如，参见这个 commit ，它与“Dirty Cow”有关：

 mm: remove gup_flags FOLL_WRITE games from __get_user_pages()
 This is an ancient bug that was actually attempted to be fixed once
 (badly) by me eleven years ago in commit 4ceb5db9757a ("Fix
 get_user_pages() race for write access") but that was then undone due to
 problems on s390 by commit f33ea7f404e5 ("fix get_user_pages bug").

 In the meantime, the s390 situation has long been fixed, and we can now
 fix it by checking the pte_dirty() bit properly (and do it better).  The
 s390 dirty bit was implemented in abf09bed3cce ("s390/mm: implement
 software dirty bits") which made it into v3.9.  Earlier kernels will
 have to look at the page state itself.

 Also, the VM has become more scalable, and what used a purely
 theoretical race back then has become easier to trigger.

 To fix it, we introduce a new internal FOLL_COW flag to mark the "yes,
 we already did a COW" rather than play racy games with FOLL_WRITE that
 is very fundamental, and then use the pte dirty flag to validate that
 the FOLL_COW flag is still valid.

 Reported-and-tested-by: Phil "not Paul" Oester <kernel@linuxace.com>
 Acked-by: Hugh Dickins <hughd@google.com>
 Reviewed-by: Michal Hocko <mhocko@suse.com>
 Cc: Andy Lutomirski <luto@kernel.org>
 Cc: Kees Cook <keescook@chromium.org>
 Cc: Oleg Nesterov <oleg@redhat.com>
 Cc: Willy Tarreau <w@1wt.eu>
 Cc: Nick Piggin <npiggin@gmail.com>
 Cc: Greg Thelen <gthelen@google.com>
 Cc: stable@vger.kernel.org
 Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

除了上面的“签收”预告片外，还有：

• “抄送”（收到有关补丁的通知）
• “Acked-by”（代码所有者承认，“对我来说看起来不错”）
• “审查人”（审查）
• “Reported-and-tested-by”（报告并测试了问题（我假设））

其他项目，例如 Gerrit，有自己的标题和相关的含义。

见： https ://git.wiki.kernel.org/index.php/CommitMessageConventions

故事的道德启示

我的印象是，虽然这个特定元数据的最初动机是一些法律问题（从其他答案来看），但这种元数据的实践已经超越了仅仅处理形成作者链的情况。

[↑1]: man git-interpret-trailers
[↑2]：似乎这些有时也被称为“sob”（首字母）。