Commit 5a63f036 authored by Akira Yokosawa's avatar Akira Yokosawa Committed by Jonathan Corbet
Browse files

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



Commit fb12098d ("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: default avatarAkira Yokosawa <akiyks@gmail.com>
Fixes: fb12098d ("docs: submit-checklist: Allow creating cross-references for ABI README")
Fixes: eb0c7141 ("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: default avatarJonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250304075734.56660-1-akiyks@gmail.com
parent e5e6c016

Documentation/process/submit-checklist.rst

+2 −1
Original line number Diff line number Diff line
@@ -52,7 +52,8 @@ Provide documentation 
4) All new module parameters are documented with ``MODULE_PARM_DESC()``



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

   linux-api@vger.kernel.org.

Documentation/translations/it_IT/process/submit-checklist.rst

+4 −3
Original line number Diff line number Diff line
@@ -58,9 +58,10 @@ Fornite documentazione 
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

    ``Documentation/ABI/``.  Leggete Documentation/ABI/README per maggiori

    informazioni.  Le patch che modificano le interfacce utente dovrebbero

    essere inviate in copia anche a linux-api@vger.kernel.org.

    ``Documentation/ABI/``.  Leggete Documentation/admin-guide/abi.rst

    (o ``Documentation/ABI/README``) per maggiori informazioni.

    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

    ``Documentation/userspace-api/ioctl/ioctl-number.rst``.

Documentation/translations/ja_JP/process/submit-checklist.rst

+2 −1
Original line number Diff line number Diff line
@@ -76,7 +76,8 @@ Kconfig 変更のレビュー 
   されている。



5) 新規ユーザースペース・インターフェースが、すべて ``Documentaion/ABI/``

   以下に記載されている。詳しくは、 ``Documentation/ABI/README`` を参照。

   以下に記載されている。詳しくは、 Documentation/admin-guide/abi.rst

   (もしくは ``Documentation/ABI/README``) を参照。

   ユーザースペース・インターフェースを変更するパッチは、

   linux-api@vger.kernel.org にも CC すべし。

Documentation/translations/sp_SP/process/submit-checklist.rst

+4 −3
Original line number Diff line number Diff line
@@ -97,9 +97,10 @@ y en otros lugares con respecto al envío de parches del kernel de Linux. 
    ``MODULE_PARM_DESC()``.



18) Todas las nuevas interfaces de espacio de usuario están documentadas

    en ``Documentation/ABI/``. Consulte Documentation/ABI/README para

    obtener más información. Los parches que cambian las interfaces del

    espacio de usuario deben ser CCed a linux-api@vger.kernel.org.

    en ``Documentation/ABI/``. Consulte Documentation/admin-guide/abi.rst

    (o ``Documentation/ABI/README``) para obtener más información.

    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

    de slab y página. Consulte ``Documentation/fault-injection/``.

Documentation/translations/zh_CN/process/submit-checklist.rst

+2 −2
Original line number Diff line number Diff line
@@ -82,8 +82,8 @@ Linux内核补丁提交检查单 
17) 所有新的模块参数都记录在 ``MODULE_PARM_DESC()``



18) 所有新的用户空间接口都记录在 ``Documentation/ABI/`` 中。有关详细信息，

    请参阅 Documentation/ABI/README 。更改用户空间接口的补丁应该抄送

    linux-api@vger.kernel.org。

    请参阅 Documentation/admin-guide/abi.rst (或 ``Documentation/ABI/README``)。

    更改用户空间接口的补丁应该抄送 linux-api@vger.kernel.org\ 。



19) 已通过至少注入slab和page分配失败进行检查。请参阅 ``Documentation/fault-injection/`` 。

    如果新代码是实质性的，那么添加子系统特定的故障注入可能是合适的。