英语

文档子系统维护者入门简介

文档“子系统”是内核文档和相关基础架构的中心协调点。它涵盖了Documentation/下的层级结构(Documentation/devicetree除外),scripts/下的各种实用程序,以及至少有时包括LICENSES/。

但值得注意的是,该子系统的边界比通常情况下要模糊得多。许多其他子系统的维护者喜欢控制Documentation/的部分内容,并且当方便时,更多人会随意地在那里应用更改。除此之外,内核的大部分文档都以kerneldoc注释的形式存在于源代码中;这些注释通常(但不总是)由相关的子系统维护者维护。

文档的邮件列表是linux-doc@vger.kernel.org。补丁应尽可能针对docs-next树进行。

提交清单附录

在进行文档更改时,您应该实际构建文档,并确保没有引入新的错误或警告。生成HTML文档并查看结果将有助于避免对内容的呈现方式产生不必要的误解。

所有新文档(包括对现有文档的添加)都应在变更日志中的某个位置说明目标受众是谁;这样,我们才能确保文档最终出现在正确的位置。一些可能的类别包括:内核开发人员(专家或初学者)、用户空间程序员、最终用户和/或系统管理员以及发行商。

关键周期日期

补丁可以随时发送,但在合并窗口期间的响应速度会比平时慢。文档树倾向于在合并窗口打开前较晚关闭,因为文档补丁的回归风险较低。

审查节奏

我是文档子系统的唯一维护者,我正在利用自己的时间进行这项工作,因此对补丁的响应偶尔会很慢。我尽量在合并补丁时(或者当我决定不能合并时)发送通知。如果您在发送补丁后一周内没有收到回复,请随时发送ping。