Linux内核社区贡献指南

向Linux内核贡献代码是一个严格但有价值的过程。本指南详细介绍从准备补丁到提交邮件的完整流程，帮助你成功向内核社区贡献代码。

1.1 获取内核源码

克隆Linus的主线树

git clone https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git

cd linux

添加linux-next树（包含下一版本的特性）

git remote add linux-next https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git

git fetch linux-next

添加稳定版树

git remote add stable https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git

git fetch stable

1.2 配置Git

设置用户信息

git config --global user.name "Your Name"

git config --global user.email "your.email@example.com"

设置编辑器

git config --global core.editor vim

配置发送邮件

git config --global sendemail.smtpserver smtp.gmail.com

git config --global sendemail.smtpserverport 587

git config --global sendemail.smtpencryption tls

git config --global sendemail.smtpuser your.email@example.com

设置补丁格式

git config --global format.numbered auto

git config --global format.signoff true

1.3 安装必要工具

代码检查工具

sudo apt install sparse coccinelle

邮件工具

sudo apt install git-email mutt

文档工具

sudo apt install python3-sphinx python3-sphinx-rtd-theme

2.1 编码风格

// 内核编码风格示例

include <linux/kernel.h>

include <linux/module.h>

/*

• 函数注释使用kernel-doc格式

• @param: 参数说明

• @return: 返回值说明

*/

// 缩进使用8个字符的Tab，不是空格

void example_function(int param)

{

// 大括号位置：函数的开括号另起一行

if (param > 0) {

// 其他语句的开括号在同一行

do_something();

} else {

do_something_else();

}

// 每行最多80个字符（推荐）

// 绝对不超过100个字符

// switch语句

switch (param) {

case 0: // case与switch对齐

break;

case 1:

handle_case_1();

break;

default:

break;

}

}

// 结构体定义

struct example_struct {

int member1;

char member2;

unsigned long member3;

};  // 注意分号位置

// 宏定义

define EXAMPLE_MACRO(x) \

do { \

statement1; \

statement2; \

} while (0)

// 指针声明

char *ptr; // 星号靠近变量名，不是类型

int *a, *b, *c; // 多个指针声明

2.2 使用checkpatch检查

检查单个补丁

./scripts/checkpatch.pl patch-file.patch

检查一系列提交

git format-patch -3 --stdout | ./scripts/checkpatch.pl

检查单个文件

./scripts/checkpatch.pl -f drivers/example/file.c

忽略某些警告

./scripts/checkpatch.pl --ignore LONG_LINE,CAMELCASE patch.patch

自动修复简单问题

./scripts/checkpatch.pl --fix-inplace file.c

2.3 Sparse静态检查

安装sparse

sudo apt install sparse

编译时启用sparse检查

make C=1 drivers/example/ 检查新编译的文件

make C=2 drivers/example/ 检查所有文件

常见sparse警告

• 地址空间问题(__user, __kernel, __iomem)

• 锁定问题

• 字节序问题(__le32, __be32)

3.1 分支管理

基于主线创建工作分支

git checkout -b my-feature origin/master

或基于特定子系统树

git checkout -b my-network-fix net-next/master

保持分支更新

git fetch origin

git rebase origin/master

3.2 提交管理

创建原子提交（每个提交只做一件事）

git add -p 交互式添加部分修改

git commit -s -s 自动添加Signed-off-by

提交信息格式

subsystem: Short description (50 chars max)

Longer description explaining the what and why (72 chars width)

Can have multiple paragraphs.

Fixes: 1234567890ab ("Previous commit subject")

Reported-by: Name email@example.com

Signed-off-by: Your Name your.email@example.com

示例提交信息

cat << 'EOF'

net: ethernet: fix me