mirror of
git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2025-09-04 20:19:47 +08:00
docs/.../submit-checklist: Use Documentation/admin-guide/abi.rst for cross-ref of README
Commitfb12098d8e
("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:fb12098d8e
("docs: submit-checklist: Allow creating cross-references for ABI README") Fixes:eb0c714120
("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
This commit is contained in:
parent
e5e6c016fc
commit
5a63f0369b
@ -52,7 +52,8 @@ Provide documentation
|
|||||||
4) All new module parameters are documented with ``MODULE_PARM_DESC()``
|
4) All new module parameters are documented with ``MODULE_PARM_DESC()``
|
||||||
|
|
||||||
5) All new userspace interfaces are documented in ``Documentation/ABI/``.
|
5) All new userspace interfaces are documented in ``Documentation/ABI/``.
|
||||||
See Documentation/ABI/README for more information.
|
See Documentation/admin-guide/abi.rst (or ``Documentation/ABI/README``)
|
||||||
|
for more information.
|
||||||
Patches that change userspace interfaces should be CCed to
|
Patches that change userspace interfaces should be CCed to
|
||||||
linux-api@vger.kernel.org.
|
linux-api@vger.kernel.org.
|
||||||
|
|
||||||
|
@ -58,9 +58,10 @@ Fornite documentazione
|
|||||||
4) Tutti i nuovi parametri dei moduli sono documentati con ``MODULE_PARM_DESC()``.
|
4) Tutti i nuovi parametri dei moduli sono documentati con ``MODULE_PARM_DESC()``.
|
||||||
|
|
||||||
5) Tutte le nuove interfacce verso lo spazio utente sono documentate in
|
5) Tutte le nuove interfacce verso lo spazio utente sono documentate in
|
||||||
``Documentation/ABI/``. Leggete Documentation/ABI/README per maggiori
|
``Documentation/ABI/``. Leggete Documentation/admin-guide/abi.rst
|
||||||
informazioni. Le patch che modificano le interfacce utente dovrebbero
|
(o ``Documentation/ABI/README``) per maggiori informazioni.
|
||||||
essere inviate in copia anche a linux-api@vger.kernel.org.
|
Le patch che modificano le interfacce utente dovrebbero essere inviate
|
||||||
|
in copia anche a linux-api@vger.kernel.org.
|
||||||
|
|
||||||
6) Se la patch aggiunge nuove chiamate ioctl, allora aggiornate
|
6) Se la patch aggiunge nuove chiamate ioctl, allora aggiornate
|
||||||
``Documentation/userspace-api/ioctl/ioctl-number.rst``.
|
``Documentation/userspace-api/ioctl/ioctl-number.rst``.
|
||||||
|
@ -76,7 +76,8 @@ Kconfig 変更のレビュー
|
|||||||
されている。
|
されている。
|
||||||
|
|
||||||
5) 新規ユーザースペース・インターフェースが、すべて ``Documentaion/ABI/``
|
5) 新規ユーザースペース・インターフェースが、すべて ``Documentaion/ABI/``
|
||||||
以下に記載されている。詳しくは、 ``Documentation/ABI/README`` を参照。
|
以下に記載されている。詳しくは、 Documentation/admin-guide/abi.rst
|
||||||
|
(もしくは ``Documentation/ABI/README``) を参照。
|
||||||
ユーザースペース・インターフェースを変更するパッチは、
|
ユーザースペース・インターフェースを変更するパッチは、
|
||||||
linux-api@vger.kernel.org にも CC すべし。
|
linux-api@vger.kernel.org にも CC すべし。
|
||||||
|
|
||||||
|
@ -97,9 +97,10 @@ y en otros lugares con respecto al envío de parches del kernel de Linux.
|
|||||||
``MODULE_PARM_DESC()``.
|
``MODULE_PARM_DESC()``.
|
||||||
|
|
||||||
18) Todas las nuevas interfaces de espacio de usuario están documentadas
|
18) Todas las nuevas interfaces de espacio de usuario están documentadas
|
||||||
en ``Documentation/ABI/``. Consulte Documentation/ABI/README para
|
en ``Documentation/ABI/``. Consulte Documentation/admin-guide/abi.rst
|
||||||
obtener más información. Los parches que cambian las interfaces del
|
(o ``Documentation/ABI/README``) para obtener más información.
|
||||||
espacio de usuario deben ser CCed a linux-api@vger.kernel.org.
|
Los parches que cambian las interfaces del espacio de usuario deben
|
||||||
|
ser CCed a linux-api@vger.kernel.org.
|
||||||
|
|
||||||
19) Se ha comprobado con la inyección de al menos errores de asignación
|
19) Se ha comprobado con la inyección de al menos errores de asignación
|
||||||
de slab y página. Consulte ``Documentation/fault-injection/``.
|
de slab y página. Consulte ``Documentation/fault-injection/``.
|
||||||
|
@ -82,8 +82,8 @@ Linux内核补丁提交检查单
|
|||||||
17) 所有新的模块参数都记录在 ``MODULE_PARM_DESC()``
|
17) 所有新的模块参数都记录在 ``MODULE_PARM_DESC()``
|
||||||
|
|
||||||
18) 所有新的用户空间接口都记录在 ``Documentation/ABI/`` 中。有关详细信息,
|
18) 所有新的用户空间接口都记录在 ``Documentation/ABI/`` 中。有关详细信息,
|
||||||
请参阅 Documentation/ABI/README 。更改用户空间接口的补丁应该抄送
|
请参阅 Documentation/admin-guide/abi.rst (或 ``Documentation/ABI/README``)。
|
||||||
linux-api@vger.kernel.org。
|
更改用户空间接口的补丁应该抄送 linux-api@vger.kernel.org\ 。
|
||||||
|
|
||||||
19) 已通过至少注入slab和page分配失败进行检查。请参阅 ``Documentation/fault-injection/`` 。
|
19) 已通过至少注入slab和page分配失败进行检查。请参阅 ``Documentation/fault-injection/`` 。
|
||||||
如果新代码是实质性的,那么添加子系统特定的故障注入可能是合适的。
|
如果新代码是实质性的,那么添加子系统特定的故障注入可能是合适的。
|
||||||
|
@ -85,8 +85,8 @@ Linux內核補丁提交檢查單
|
|||||||
17) 所有新的模塊參數都記錄在 ``MODULE_PARM_DESC()``
|
17) 所有新的模塊參數都記錄在 ``MODULE_PARM_DESC()``
|
||||||
|
|
||||||
18) 所有新的用戶空間接口都記錄在 ``Documentation/ABI/`` 中。有關詳細信息,
|
18) 所有新的用戶空間接口都記錄在 ``Documentation/ABI/`` 中。有關詳細信息,
|
||||||
請參閱 Documentation/ABI/README 。更改用戶空間接口的補丁應該抄送
|
請參閱 Documentation/admin-guide/abi.rst (或 ``Documentation/ABI/README``)。
|
||||||
linux-api@vger.kernel.org。
|
更改用戶空間接口的補丁應該抄送 linux-api@vger.kernel.org\ 。
|
||||||
|
|
||||||
19) 已通過至少注入slab和page分配失敗進行檢查。請參閱 ``Documentation/fault-injection/`` 。
|
19) 已通過至少注入slab和page分配失敗進行檢查。請參閱 ``Documentation/fault-injection/`` 。
|
||||||
如果新代碼是實質性的,那麼添加子系統特定的故障注入可能是合適的。
|
如果新代碼是實質性的,那麼添加子系統特定的故障注入可能是合適的。
|
||||||
|
Loading…
Reference in New Issue
Block a user