gfreewind/kernel_comment项目：Linux内核补丁提交检查清单详解

前言

在Linux内核开发过程中，提交高质量的补丁是每个开发者都需要掌握的核心技能。本文基于gfreewind/kernel_comment项目中的提交检查清单文档，深入解析Linux内核补丁提交的各项要求，帮助开发者理解并遵循内核社区的开发规范。

内核补丁提交的基本要求

1. 头文件包含规范

在编写内核代码时，必须显式包含所使用的每个设施的头文件。不要依赖其他头文件间接包含你需要的定义。这是良好的编程实践，可以避免潜在的编译问题和维护困难。

2. 构建测试要求

一个合格的内核补丁必须满足以下构建测试：

• 在各种配置选项下都能干净构建（=y、=m、=n）
• 通过allnoconfig和allmodconfig测试
• 支持O=builddir构建方式
• 能够在多种CPU架构上成功构建

特别建议使用ppc64架构进行交叉编译检查，因为该架构通常使用unsigned long表示64位量，可以帮助发现潜在的类型问题。

代码风格与文档要求

1. 代码风格检查

所有补丁必须符合内核编码风格规范。开发者应该：

• 使用scripts/checkpatch.pl检查补丁中的风格问题
• 能够合理解释补丁中保留的任何风格违规
• 特别注意缩进、括号使用、变量命名等细节

2. 配置选项规范

新增或修改的CONFIG选项必须：

• 不影响现有配置菜单的结构
• 默认设置为off，除非有充分理由
• 提供完整的帮助文本
• 经过各种Kconfig组合的仔细审查

静态分析与测试要求

1. 静态分析工具

提交前必须使用以下工具进行检查：

• sparse静态分析工具
• make checkstack检查栈使用情况（超过512字节的函数需要优化）
• make namespacecheck检查命名空间问题

2. 内核文档

所有全局内核API必须使用kernel-doc进行文档化。可以通过以下命令检查文档：

make htmldocs
make pdfdocs

运行时测试要求

1. 调试选项测试

补丁必须在以下调试选项同时启用的情况下测试通过：

CONFIG_PREEMPT
CONFIG_DEBUG_PREEMPT  
CONFIG_DEBUG_SLAB
CONFIG_DEBUG_PAGEALLOC
CONFIG_DEBUG_MUTEXES
CONFIG_DEBUG_SPINLOCK
CONFIG_DEBUG_ATOMIC_SLEEP  
CONFIG_PROVE_RCU
CONFIG_DEBUG_OBJECTS_RCU_HEAD

2. SMP和PREEMPT测试

必须测试补丁在以下情况下的表现：

• 启用/禁用CONFIG_SMP
• 启用/禁用CONFIG_PREEMPT

3. 故障注入测试

使用内核的故障注入机制测试补丁：

• 至少注入slab和page-allocation故障
• 对于大型新代码，考虑添加子系统特定的故障注入

用户接口与特殊注意事项

1. 用户空间接口

所有新用户空间接口必须：

• 在Documentation/ABI/下进行文档化
• 变更用户空间接口的补丁需要抄送linux-api邮件列表

2. 特殊注意事项

• 新增/proc条目必须在Documentation/下文档化
• 新增内核启动参数必须更新Documentation/admin-guide/kernel-parameters.rst
• 新增模块参数必须使用MODULE_PARM_DESC()进行文档化
• 新增ioctl必须更新Documentation/ioctl/ioctl-number.txt

3. 内存屏障

所有内存屏障操作（如barrier()、rmb()、wmb()）必须：

• 在源代码中添加注释
• 解释其作用和必要性

高级测试建议

1. 编译器警告检查

使用gcc的-W选项编译新代码：

make EXTRA_CFLAGS=-W

虽然会产生大量警告，但有助于发现如"有符号和无符号比较"等潜在问题。

2. 组合配置测试

测试补丁在与以下Kconfig符号相关的各种组合下的表现：

CONFIG_SMP
CONFIG_SYSFS  
CONFIG_PROC_FS
CONFIG_INPUT
CONFIG_PCI
CONFIG_BLOCK
CONFIG_PM
CONFIG_MAGIC_SYSRQ
CONFIG_NET
CONFIG_INET=n（但CONFIG_NET=y）

结语

遵循这份详尽的检查清单将大大提高你的内核补丁被接受的可能性。内核开发是一个严谨的过程，每个补丁都需要经过多方面的验证。通过系统性地检查每个项目，开发者可以确保提交的代码质量达到内核社区的高标准要求。