submit-checklist.rst (4978B)
1.. SPDX-License-Identifier: GPL-2.0 2 3.. include:: ../disclaimer-zh_TW.rst 4 5:Original: :ref:`Documentation/process/submit-checklist.rst <submitchecklist>` 6:Translator: Alex Shi <alex.shi@linux.alibaba.com> 7 Hu Haowen <src.res@email.cn> 8 9.. _tw_submitchecklist: 10 11Linux內核補丁提交清單 12~~~~~~~~~~~~~~~~~~~~~ 13 14如果開發人員希望看到他們的內核補丁提交更快地被接受，那麼他們應該做一些基本 15的事情。 16 17這些都是在 18:ref:`Documentation/translations/zh_TW/process/submitting-patches.rst <tw_submittingpatches>` 19和其他有關提交Linux內核補丁的文檔中提供的。 20 211) 如果使用工具，則包括定義/聲明該工具的文件。不要依賴於其他頭文件拉入您使用 22 的頭文件。 23 242) 乾淨的編譯： 25 26 a) 使用適用或修改的 ``CONFIG`` 選項 ``=y``、``=m`` 和 ``=n`` 。沒有GCC 27 警告/錯誤，沒有連結器警告/錯誤。 28 29 b) 通過allnoconfig、allmodconfig 30 31 c) 使用 ``O=builddir`` 時可以成功編譯 32 333) 通過使用本地交叉編譯工具或其他一些構建場在多個CPU體系結構上構建。 34 354) PPC64是一種很好的交叉編譯檢查體系結構，因爲它傾向於對64位的數使用無符號 36 長整型。 37 385) 如下所述 :ref:`Documentation/translations/zh_TW/process/coding-style.rst <tw_codingstyle>`. 39 檢查您的補丁是否爲常規樣式。在提交（ ``scripts/check patch.pl`` ）之前， 40 使用補丁樣式檢查器檢查是否有輕微的衝突。您應該能夠處理您的補丁中存在的所有 41 違規行爲。 42 436) 任何新的或修改過的 ``CONFIG`` 選項都不會弄髒配置菜單，並默認爲關閉，除非 44 它們符合 ``Documentation/kbuild/kconfig-language.rst`` 中記錄的異常條件, 45 菜單屬性：默認值. 46 477) 所有新的 ``kconfig`` 選項都有幫助文本。 48 498) 已仔細審查了相關的 ``Kconfig`` 組合。這很難用測試來糾正——腦力在這裡是有 50 回報的。 51 529) 用 sparse 檢查乾淨。 53 5410) 使用 ``make checkstack`` 和 ``make namespacecheck`` 並修復他們發現的任何 55 問題。 56 57 .. note:: 58 59 ``checkstack`` 並沒有明確指出問題，但是任何一個在堆棧上使用超過512 60 字節的函數都可以進行更改。 61 6211) 包括 :ref:`kernel-doc <kernel_doc>` 內核文檔以記錄全局內核API。（靜態函數 63 不需要，但也可以。）使用 ``make htmldocs`` 或 ``make pdfdocs`` 檢查 64 :ref:`kernel-doc <kernel_doc>` 並修復任何問題。 65 6612) 通過以下選項同時啓用的測試 ``CONFIG_PREEMPT``, ``CONFIG_DEBUG_PREEMPT``, 67 ``CONFIG_DEBUG_SLAB``, ``CONFIG_DEBUG_PAGEALLOC``, ``CONFIG_DEBUG_MUTEXES``, 68 ``CONFIG_DEBUG_SPINLOCK``, ``CONFIG_DEBUG_ATOMIC_SLEEP``, 69 ``CONFIG_PROVE_RCU`` and ``CONFIG_DEBUG_OBJECTS_RCU_HEAD`` 70 7113) 已經過構建和運行時測試，包括有或沒有 ``CONFIG_SMP``, ``CONFIG_PREEMPT``. 72 7314) 如果補丁程序影響IO/磁碟等：使用或不使用 ``CONFIG_LBDAF`` 進行測試。 74 7515) 所有代碼路徑都已在啓用所有lockdep功能的情況下運行。 76 7716) 所有新的/proc條目都記錄在 ``Documentation/`` 78 7917) 所有新的內核引導參數都記錄在 80 Documentation/admin-guide/kernel-parameters.rst 中。 81 8218) 所有新的模塊參數都記錄在 ``MODULE_PARM_DESC()`` 83 8419) 所有新的用戶空間接口都記錄在 ``Documentation/ABI/`` 中。有關詳細信息， 85 請參閱 ``Documentation/ABI/README`` 。更改用戶空間接口的補丁應該抄送 86 linux-api@vger.kernel.org。 87 8820) 已通過至少注入slab和page分配失敗進行檢查。請參閱 ``Documentation/fault-injection/`` 89 如果新代碼是實質性的，那麼添加子系統特定的故障注入可能是合適的。 90 9121) 新添加的代碼已經用 ``gcc -W`` 編譯（使用 ``make EXTRA-CFLAGS=-W`` ）。這 92 將產生大量噪聲，但對於查找諸如「警告：有符號和無符號之間的比較」之類的錯誤 93 很有用。 94 9522) 在它被合併到-mm補丁集中之後進行測試，以確保它仍然與所有其他排隊的補丁以 96 及VM、VFS和其他子系統中的各種更改一起工作。 97 9823) 所有內存屏障例如 ``barrier()``, ``rmb()``, ``wmb()`` 都需要原始碼中的注 99 釋來解釋它們正在執行的操作及其原因的邏輯。 100 10124) 如果補丁添加了任何ioctl，那麼也要更新 ``Documentation/userspace-api/ioctl/ioctl-number.rst`` 102 10325) 如果修改後的原始碼依賴或使用與以下 ``Kconfig`` 符號相關的任何內核API或 104 功能，則在禁用相關 ``Kconfig`` 符號和/或 ``=m`` （如果該選項可用）的情況 105 下測試以下多個構建[並非所有這些都同時存在，只是它們的各種/隨機組合]： 106 107 ``CONFIG_SMP``, ``CONFIG_SYSFS``, ``CONFIG_PROC_FS``, ``CONFIG_INPUT``, ``CONFIG_PCI``, ``CONFIG_BLOCK``, ``CONFIG_PM``, ``CONFIG_MAGIC_SYSRQ``, 108 ``CONFIG_NET``, ``CONFIG_INET=n`` (但是後者伴隨 ``CONFIG_NET=y``). 109