Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs/.../submit-checklist: Use Documentation/admin-guide/abi.rst for cross-ref of README

Commit fb12098d8ee4 ("docs: submit-checklist: Allow creating
cross-references for ABI README") assumes that the path of
"Documentation/ABI/README" would be converted to a cross-ref to
the README.

However, as the README is included by the "kernel-abi" directive
at Documentation/admin-guide/abi.rst, the expected conversion
does not happen.

Instead, use the path where the "kernel-abi" directive exists for
the conversion to work. Restore the original path of README in
inline-literal form as an additional note for readers of the .rst
file.

Apply the same changes for translations.

Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Fixes: fb12098d8ee4 ("docs: submit-checklist: Allow creating cross-references for ABI README")
Fixes: eb0c714120ba ("docs: translations: Allow creating cross-references for ABI README")
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Alex Shi <alexs@kernel.org>
Cc: Yanteng Si <si.yanteng@linux.dev>
Cc: Dongliang Mu <dzm91@hust.edu.cn>
Cc: Hu Haowen <2023002089@link.tyut.edu.cn>
Cc: Federico Vaga <federico.vaga@vaga.pv.it>
Cc: Carlos Bilbao <carlos.bilbao@kernel.org>
Cc: Avadhut Naik <avadhut.naik@amd.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250304075734.56660-1-akiyks@gmail.com

authored by

Akira Yokosawa and committed by
Jonathan Corbet
5a63f036 e5e6c016

+16 -12
+2 -1
Documentation/process/submit-checklist.rst
··· 52 52 4) All new module parameters are documented with ``MODULE_PARM_DESC()`` 53 53 54 54 5) All new userspace interfaces are documented in ``Documentation/ABI/``. 55 - See Documentation/ABI/README for more information. 55 + See Documentation/admin-guide/abi.rst (or ``Documentation/ABI/README``) 56 + for more information. 56 57 Patches that change userspace interfaces should be CCed to 57 58 linux-api@vger.kernel.org. 58 59
+4 -3
Documentation/translations/it_IT/process/submit-checklist.rst
··· 58 58 4) Tutti i nuovi parametri dei moduli sono documentati con ``MODULE_PARM_DESC()``. 59 59 60 60 5) Tutte le nuove interfacce verso lo spazio utente sono documentate in 61 - ``Documentation/ABI/``. Leggete Documentation/ABI/README per maggiori 62 - informazioni. Le patch che modificano le interfacce utente dovrebbero 63 - essere inviate in copia anche a linux-api@vger.kernel.org. 61 + ``Documentation/ABI/``. Leggete Documentation/admin-guide/abi.rst 62 + (o ``Documentation/ABI/README``) per maggiori informazioni. 63 + Le patch che modificano le interfacce utente dovrebbero essere inviate 64 + in copia anche a linux-api@vger.kernel.org. 64 65 65 66 6) Se la patch aggiunge nuove chiamate ioctl, allora aggiornate 66 67 ``Documentation/userspace-api/ioctl/ioctl-number.rst``.
+2 -1
Documentation/translations/ja_JP/process/submit-checklist.rst
··· 76 76 されている。 77 77 78 78 5) 新規ユーザースペース・インターフェースが、すべて ``Documentaion/ABI/`` 79 - 以下に記載されている。詳しくは、 ``Documentation/ABI/README`` を参照。 79 + 以下に記載されている。詳しくは、 Documentation/admin-guide/abi.rst 80 + (もしくは ``Documentation/ABI/README``) を参照。 80 81 ユーザースペース・インターフェースを変更するパッチは、 81 82 linux-api@vger.kernel.org にも CC すべし。 82 83
+4 -3
Documentation/translations/sp_SP/process/submit-checklist.rst
··· 97 97 ``MODULE_PARM_DESC()``. 98 98 99 99 18) Todas las nuevas interfaces de espacio de usuario están documentadas 100 - en ``Documentation/ABI/``. Consulte Documentation/ABI/README para 101 - obtener más información. Los parches que cambian las interfaces del 102 - espacio de usuario deben ser CCed a linux-api@vger.kernel.org. 100 + en ``Documentation/ABI/``. Consulte Documentation/admin-guide/abi.rst 101 + (o ``Documentation/ABI/README``) para obtener más información. 102 + Los parches que cambian las interfaces del espacio de usuario deben 103 + ser CCed a linux-api@vger.kernel.org. 103 104 104 105 19) Se ha comprobado con la inyección de al menos errores de asignación 105 106 de slab y página. Consulte ``Documentation/fault-injection/``.
+2 -2
Documentation/translations/zh_CN/process/submit-checklist.rst
··· 82 82 17) 所有新的模块参数都记录在 ``MODULE_PARM_DESC()`` 83 83 84 84 18) 所有新的用户空间接口都记录在 ``Documentation/ABI/`` 中。有关详细信息, 85 - 请参阅 Documentation/ABI/README 。更改用户空间接口的补丁应该抄送 86 - linux-api@vger.kernel.org。 85 + 请参阅 Documentation/admin-guide/abi.rst (或 ``Documentation/ABI/README``)。 86 + 更改用户空间接口的补丁应该抄送 linux-api@vger.kernel.org\ 。 87 87 88 88 19) 已通过至少注入slab和page分配失败进行检查。请参阅 ``Documentation/fault-injection/`` 。 89 89 如果新代码是实质性的,那么添加子系统特定的故障注入可能是合适的。
+2 -2
Documentation/translations/zh_TW/process/submit-checklist.rst
··· 85 85 17) 所有新的模塊參數都記錄在 ``MODULE_PARM_DESC()`` 86 86 87 87 18) 所有新的用戶空間接口都記錄在 ``Documentation/ABI/`` 中。有關詳細信息, 88 - 請參閱 Documentation/ABI/README 。更改用戶空間接口的補丁應該抄送 89 - linux-api@vger.kernel.org。 88 + 請參閱 Documentation/admin-guide/abi.rst (或 ``Documentation/ABI/README``)。 89 + 更改用戶空間接口的補丁應該抄送 linux-api@vger.kernel.org\ 。 90 90 91 91 19) 已通過至少注入slab和page分配失敗進行檢查。請參閱 ``Documentation/fault-injection/`` 。 92 92 如果新代碼是實質性的,那麼添加子系統特定的故障注入可能是合適的。