1.. include:: ../disclaimer-zh_CN.rst
2
3:Original: :ref:`Documentation/process/submit-checklist.rst <submitchecklist>`
4:Translator: Alex Shi <alex.shi@linux.alibaba.com>
5
6.. _cn_submitchecklist:
7
8Linux内核补丁提交清单
9~~~~~~~~~~~~~~~~~~~~~
10
11如果开发人员希望看到他们的内核补丁提交更快地被接受，那么他们应该做一些基本
12的事情。
13
14这些都是在
15:ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`
16和其他有关提交Linux内核补丁的文档中提供的。
17
181) 如果使用工具，则包括定义/声明该工具的文件。不要依赖于其他头文件拉入您使用
19   的头文件。
20
212) 干净的编译：
22
23   a) 使用适用或修改的 ``CONFIG`` 选项 ``=y``、``=m`` 和 ``=n`` 。没有GCC
24      警告/错误，没有链接器警告/错误。
25
26   b) 通过allnoconfig、allmodconfig
27
28   c) 使用 ``O=builddir`` 时可以成功编译
29
303) 通过使用本地交叉编译工具或其他一些构建场在多个CPU体系结构上构建。
31
324) PPC64是一种很好的交叉编译检查体系结构，因为它倾向于对64位的数使用无符号
33   长整型。
34
355) 如下所述 :ref:`Documentation/translations/zh_CN/process/coding-style.rst <cn_codingstyle>`.
36   检查您的补丁是否为常规样式。在提交（ ``scripts/check patch.pl`` ）之前，
37   使用补丁样式检查器检查是否有轻微的冲突。您应该能够处理您的补丁中存在的所有
38   违规行为。
39
406) 任何新的或修改过的 ``CONFIG`` 选项都不会弄脏配置菜单，并默认为关闭，除非
41   它们符合 ``Documentation/kbuild/kconfig-language.rst`` 中记录的异常条件,
42   菜单属性：默认值.
43
447) 所有新的 ``kconfig`` 选项都有帮助文本。
45
468) 已仔细审查了相关的 ``Kconfig`` 组合。这很难用测试来纠正——脑力在这里是有
47   回报的。
48
499) 用 sparse 检查干净。
50
5110) 使用 ``make checkstack`` 和 ``make namespacecheck`` 并修复他们发现的任何
52    问题。
53
54    .. note::
55
56        ``checkstack`` 并没有明确指出问题，但是任何一个在堆栈上使用超过512
57        字节的函数都可以进行更改。
58
5911) 包括 :ref:`kernel-doc <kernel_doc>` 内核文档以记录全局内核API。（静态函数
60    不需要，但也可以。）使用 ``make htmldocs`` 或 ``make pdfdocs`` 检查
61    :ref:`kernel-doc <kernel_doc>` 并修复任何问题。
62
6312) 通过以下选项同时启用的测试 ``CONFIG_PREEMPT``, ``CONFIG_DEBUG_PREEMPT``,
64    ``CONFIG_DEBUG_SLAB``, ``CONFIG_DEBUG_PAGEALLOC``, ``CONFIG_DEBUG_MUTEXES``,
65    ``CONFIG_DEBUG_SPINLOCK``, ``CONFIG_DEBUG_ATOMIC_SLEEP``,
66    ``CONFIG_PROVE_RCU`` and ``CONFIG_DEBUG_OBJECTS_RCU_HEAD``
67
6813) 已经过构建和运行时测试，包括有或没有 ``CONFIG_SMP``, ``CONFIG_PREEMPT``.
69
7014) 如果补丁程序影响IO/磁盘等：使用或不使用 ``CONFIG_LBDAF`` 进行测试。
71
7215) 所有代码路径都已在启用所有lockdep功能的情况下运行。
73
7416) 所有新的/proc条目都记录在 ``Documentation/``
75
7617) 所有新的内核引导参数都记录在
77    Documentation/admin-guide/kernel-parameters.rst 中。
78
7918) 所有新的模块参数都记录在 ``MODULE_PARM_DESC()``
80
8119) 所有新的用户空间接口都记录在 ``Documentation/ABI/`` 中。有关详细信息，
82    请参阅 ``Documentation/ABI/README`` 。更改用户空间接口的补丁应该抄送
83    linux-api@vger.kernel.org。
84
8520) 已通过至少注入slab和page分配失败进行检查。请参阅 ``Documentation/fault-injection/``
86    如果新代码是实质性的，那么添加子系统特定的故障注入可能是合适的。
87
8821) 新添加的代码已经用 ``gcc -W`` 编译（使用 ``make EXTRA-CFLAGS=-W`` ）。这
89    将产生大量噪声，但对于查找诸如“警告：有符号和无符号之间的比较”之类的错误
90    很有用。
91
9222) 在它被合并到-mm补丁集中之后进行测试，以确保它仍然与所有其他排队的补丁以
93    及VM、VFS和其他子系统中的各种更改一起工作。
94
9523) 所有内存屏障例如 ``barrier()``, ``rmb()``, ``wmb()`` 都需要源代码中的注
96    释来解释它们正在执行的操作及其原因的逻辑。
97
9824) 如果补丁添加了任何ioctl，那么也要更新 ``Documentation/userspace-api/ioctl/ioctl-number.rst``
99
10025) 如果修改后的源代码依赖或使用与以下 ``Kconfig`` 符号相关的任何内核API或
101    功能，则在禁用相关 ``Kconfig`` 符号和/或 ``=m`` （如果该选项可用）的情况
102    下测试以下多个构建[并非所有这些都同时存在，只是它们的各种/随机组合]：
103
104    ``CONFIG_SMP``, ``CONFIG_SYSFS``, ``CONFIG_PROC_FS``, ``CONFIG_INPUT``, ``CONFIG_PCI``, ``CONFIG_BLOCK``, ``CONFIG_PM``, ``CONFIG_MAGIC_SYSRQ``,
105    ``CONFIG_NET``, ``CONFIG_INET=n`` (但是后者伴随 ``CONFIG_NET=y``).
106