首页 > 系统相关 >Linux 内核补丁提交的清单 【ChatGPT】

Linux 内核补丁提交的清单 【ChatGPT】

时间:2023-12-08 22:56:19浏览次数:48  
标签:Documentation 补丁 使用 内核 Linux DEBUG ChatGPT CONFIG

这是一个关于 Linux 内核补丁提交的清单,开发者如果想要更快地看到他们的内核补丁被接受,应该做一些基本的事情。

这些事情都超出了《Documentation/process/submitting-patches.rst》和其他关于提交 Linux 内核补丁的文档提供的内容。

  • 如果你使用了某个设施,那么请 #include 定义/声明该设施的文件。不要依赖其他头文件来引入你所使用的头文件。

  • 清晰地构建:

    • 使用适用或修改后的 CONFIG 选项 =y, =m, 和 =n。没有 gcc 警告/错误,没有链接器警告/错误。
    • 通过 allnoconfig, allmodconfig
    • 使用 O=builddir 成功构建
    • 任何 Documentation/ 的更改都能成功构建,没有新的警告/错误。使用 make htmldocs 或 make pdfdocs 来检查构建并修复任何问题。
  • 在多个 CPU 架构上构建,使用本地交叉编译工具或其他构建工具。

  • ppc64 是一个用于交叉编译检查的良好架构,因为它倾向于使用无符号长整型来表示 64 位数量。

  • 检查你的补丁是否符合《Documentation/process/coding-style.rst》中详细描述的一般风格。在提交之前使用 patch 风格检查器(scripts/checkpatch.pl)检查是否存在微不足道的违规。你应该能够证明你的补丁中存在的所有违规都是合理的。

  • 任何新的或修改后的 CONFIG 选项不会混乱配置菜单,并且默认关闭,除非它们符合《Documentation/kbuild/kconfig-language.rst》中记录的例外标准。菜单属性:默认值。

  • 所有新的 Kconfig 选项都有帮助文本。

  • 已经仔细审查了与相关 Kconfig 组合相关的内容。这在测试中很难做到正确,但在这里付出的智力努力会得到回报。

  • 使用 sparse 进行清晰检查。

  • 使用 make checkstack 并修复它发现的任何问题。

  • 注意:

    • checkstack 不会明确指出问题,但任何一个在栈上使用超过 512 字节的函数都可能需要更改。
  • 包含 kernel-doc 来记录全局内核 API。(对于静态函数不是必需的,但在那里也可以使用。)使用 make htmldocs 或 make pdfdocs 来检查 kernel-doc 并修复任何问题。

  • 已经测试了 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 同时启用。

  • 已经进行了构建和运行测试,包括启用和禁用 CONFIG_SMP 和 CONFIG_PREEMPT。

  • 所有代码路径都已经启用了所有 lockdep 功能。

  • 所有新的 /proc 条目都在《Documentation/》下有文档。

  • 所有新的内核引导参数都在《Documentation/admin-guide/kernel-parameters.rst》中有文档。

  • 所有新的模块参数都使用 MODULE_PARM_DESC() 进行了文档化。

  • 所有新的用户空间接口都在《Documentation/ABI/》中有文档。查看《Documentation/ABI/README》获取更多信息。修改用户空间接口的补丁应该抄送到 [email protected]

  • 已经检查了至少有 slab 和页面分配失败的注入。参见《Documentation/fault-injection/》。

  • 如果新代码很重要,可能需要添加特定子系统的故障注入。

  • 新添加的代码已经使用 gcc -W 进行了编译(使用 make KCFLAGS=-W)。这将产生大量噪音,但有助于发现诸如“警告:在有符号和无符号之间的比较”之类的错误。

  • 在合并到 -mm 补丁集后进行了测试,以确保它仍然能够与所有其他排队的补丁以及 VM、VFS 和其他子系统中的各种更改一起正常工作。

  • 所有内存屏障 {例如,barrier(), rmb(), wmb()} 都需要在源代码中有注释,解释它们的逻辑和原因。

  • 如果补丁添加了任何 ioctl,那么还需要更新《Documentation/userspace-api/ioctl/ioctl-number.rst》。

  • 如果你修改的源代码依赖于或使用与以下 Kconfig 符号相关的内核 API 或特性,那么请测试多个构建,禁用和/或 =m 相关的 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)。

标签:Documentation,补丁,使用,内核,Linux,DEBUG,ChatGPT,CONFIG
From: https://www.cnblogs.com/pengdonglin137/p/17889221.html

相关文章

  • 进一步内核文档索引【ChatGPT】
    https://www.kernel.org/doc/html/v6.6/process/kernel-docs.html进一步内核文档索引像这样的文档的需求在linux-kernel邮件列表中变得明显,因为相同的问题一次又一次地出现,要求指向信息。幸运的是,随着越来越多的人开始使用GNU/Linux,越来越多的人对内核感兴趣。但是仅仅阅......
  • Linux内核驱动程序接口 【ChatGPT】
    https://www.kernel.org/doc/html/v6.6/process/stable-api-nonsense.html#binary-kernel-interfaceLinux内核驱动程序接口(回答你的所有问题以及更多)[email protected]这篇文章旨在解释为什么Linux没有二进制内核接口,也没有稳定的内核接口。注意请注意......
  • 处理回归 【ChatGPT】
    https://www.kernel.org/doc/html/v6.6/process/handling-regressions.html#处理回归我们不会引起回归-本文描述了对开发人员来说,“Linux内核开发的第一法则”在实践中意味着什么。它是对报告回归的补充,该报告从用户的角度涵盖了这个主题;如果你从未阅读过那篇文章,至少在继续......
  • Linux内核许可规则 【ChatGPT】
    https://www.kernel.org/doc/html/v6.6/process/license-rules.htmlLinux内核许可规则Linux内核仅在GNU通用公共许可证第2版(GPL-2.0)的条款下提供,如LICENSES/preferred/GPL-2.0中所述,并在LICENSES/exceptions/Linux-syscall-note中描述了明确的系统调用例外情况,如COPYING文件中......
  • 内核维护者手册 - 维护者入口配置文件【ChatGPT】
    https://www.kernel.org/doc/html/v6.6/maintainer/maintainer-entry-profile.html维护者入口配置文件维护者入口配置文件是对顶层流程文档(提交补丁、提交驱动程序等)的补充,其中包括子系统/设备驱动程序本地习俗以及有关补丁提交生命周期的详细信息。贡献者使用此文档来调整他......
  • 内核维护者手册 - 修改补丁【ChatGPT】
    https://www.kernel.org/doc/html/v6.6/maintainer/modifying-patches.html修改补丁如果你是一个子系统或分支的维护者,有时你需要稍微修改你收到的补丁才能合并它们,因为你的代码与提交者的代码并不完全相同。如果你严格遵守开发者证书的规则(c),你应该要求提交者重新生成补丁,但......
  • 内核维护者手册 - 变基和合并【ChatGPT】
    https://www.kernel.org/doc/html/v6.6/maintainer/rebasing-and-merging.html重基和合并一般来说,维护一个子系统需要熟悉Git源代码管理系统。Git是一个功能强大的工具,具有许多特性;通常情况下,对于这类工具来说,使用这些特性有正确和错误的方式。本文特别关注重基和合并的使......
  • 内核维护者手册 - 创建拉取请求【ChatGPT】
    https://www.kernel.org/doc/html/v6.6/maintainer/pull-requests.html创建拉取请求本章描述了维护者如何创建并提交拉取请求给其他维护者。这对于将一个维护者的更改传输到另一个维护者的树中非常有用。这份文档是由TobinC.Harding(当时并不是一位经验丰富的维护者)根据Greg......
  • 内核维护者手册 - 处理混乱的拉取请求差异统计【ChatGPT】
    https://www.kernel.org/doc/html/v6.6/maintainer/messy-diffstat.html处理混乱的拉取请求差异统计子系统维护者通常在将工作发送到上游的过程中使用gitrequest-pull命令。通常,结果包括一个漂亮的差异统计,显示将要修改的文件以及每个文件将被修改的程度。然而,偶尔会出现一个......
  • 内核维护者手册 - 特性和驱动程序维护者【ChatGPT】
    https://www.kernel.org/doc/html/v6.6/maintainer/feature-and-driver-maintainers.html术语“维护者”涵盖了从处理补丁和拉取请求几乎全职工作的人,到负责小特性或驱动程序的人的广泛范围。与本章的大部分内容不同,本节适用于后者(更多人的群体)。它提供了维护者小规模代码部分......