在日前宣布推出 Linux 6.12-rc2 的公告中,Linus Torvalds 对内核维护者 commit 信息的英文语法也提出了更多要求。
他希望,内核维护者在描述拉取请求中的变更时能够避免使用被动语态,更多的使用主动语态、命令式语气。
我试图让我的合并 commit 信息具有一定的“凝聚力”,所以我经常编辑拉取请求的语言,以匹配更标准的布局和语言。这不是什么大不了的事,通常只是与 whitespace 有关,这样我们就不会有 15 种不同的缩进模式和项目符号语法。反正我一般都是在阅读文本的时候做的,所以也不会给我带来额外的工作。 但是,当一些维护者使用被动语态时,我会尝试主动重写解释,这确实会增加额外的工作量。 所以我会要求维护者使用主动语态,最好只是命令式。 换一种说法: 如果大家能避免将描述写成“In this pull request, the Xyzzy driver error handling was fixed to avoid a NULL pointer dereference”,我会非常高兴。 可以写成“This fixes a NULL pointer dereference in ..”;或者,如果只是列出要点,则可以直接写成“Fix NULL pointer dereference in ..”。 我知道这不是什么大问题。但上周我碰巧试着重写了几个这样的案例,我觉得简单明了的语言更好。命令语气的“Fix X”就已经很清楚了。
我试图让我的合并 commit 信息具有一定的“凝聚力”,所以我经常编辑拉取请求的语言,以匹配更标准的布局和语言。这不是什么大不了的事,通常只是与 whitespace 有关,这样我们就不会有 15 种不同的缩进模式和项目符号语法。反正我一般都是在阅读文本的时候做的,所以也不会给我带来额外的工作。
但是,当一些维护者使用被动语态时,我会尝试主动重写解释,这确实会增加额外的工作量。 所以我会要求维护者使用主动语态,最好只是命令式。
换一种说法: 如果大家能避免将描述写成“In this pull request, the Xyzzy driver error handling was fixed to avoid a NULL pointer dereference”,我会非常高兴。
可以写成“This fixes a NULL pointer dereference in ..”;或者,如果只是列出要点,则可以直接写成“Fix NULL pointer dereference in ..”。
我知道这不是什么大问题。但上周我碰巧试着重写了几个这样的案例,我觉得简单明了的语言更好。命令语气的“Fix X”就已经很清楚了。
更多详情可查看邮件列表。
评论删除后,数据将无法恢复
Linus Torvalds 向“被动语态”宣战
在日前宣布推出 Linux 6.12-rc2 的公告中,Linus Torvalds 对内核维护者 commit 信息的英文语法也提出了更多要求。
他希望,内核维护者在描述拉取请求中的变更时能够避免使用被动语态,更多的使用主动语态、命令式语气。
更多详情可查看邮件列表。