Skip to content

Commit 5a63f03

Browse files
akiyksJonathan Corbet
authored andcommitted
docs/.../submit-checklist: Use Documentation/admin-guide/abi.rst for cross-ref of README
Commit fb12098 ("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 <[email protected]> Fixes: fb12098 ("docs: submit-checklist: Allow creating cross-references for ABI README") Fixes: eb0c714 ("docs: translations: Allow creating cross-references for ABI README") Cc: Mauro Carvalho Chehab <[email protected]> Cc: Alex Shi <[email protected]> Cc: Yanteng Si <[email protected]> Cc: Dongliang Mu <[email protected]> Cc: Hu Haowen <[email protected]> Cc: Federico Vaga <[email protected]> Cc: Carlos Bilbao <[email protected]> Cc: Avadhut Naik <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
1 parent e5e6c01 commit 5a63f03

File tree

6 files changed

+16
-12
lines changed

6 files changed

+16
-12
lines changed

Documentation/process/submit-checklist.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ Provide documentation
5252
4) All new module parameters are documented with ``MODULE_PARM_DESC()``
5353

5454
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.
5657
Patches that change userspace interfaces should be CCed to
5758
5859

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,10 @@ Fornite documentazione
5858
4) Tutti i nuovi parametri dei moduli sono documentati con ``MODULE_PARM_DESC()``.
5959

6060
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 [email protected].
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 [email protected].
6465

6566
6) Se la patch aggiunge nuove chiamate ioctl, allora aggiornate
6667
``Documentation/userspace-api/ioctl/ioctl-number.rst``.

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,8 @@ Kconfig 変更のレビュー
7676
されている。
7777

7878
5) 新規ユーザースペース・インターフェースが、すべて ``Documentaion/ABI/``
79-
以下に記載されている。詳しくは、 ``Documentation/ABI/README`` を参照。
79+
以下に記載されている。詳しくは、 Documentation/admin-guide/abi.rst
80+
(もしくは ``Documentation/ABI/README``) を参照。
8081
ユーザースペース・インターフェースを変更するパッチは、
8182
[email protected] にも CC すべし。
8283

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,10 @@ y en otros lugares con respecto al envío de parches del kernel de Linux.
9797
``MODULE_PARM_DESC()``.
9898

9999
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 [email protected].
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 [email protected].
103104

104105
19) Se ha comprobado con la inyección de al menos errores de asignación
105106
de slab y página. Consulte ``Documentation/fault-injection/``.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ Linux内核补丁提交检查单
8282
17) 所有新的模块参数都记录在 ``MODULE_PARM_DESC()``
8383

8484
18) 所有新的用户空间接口都记录在 ``Documentation/ABI/`` 中。有关详细信息,
85-
请参阅 Documentation/ABI/README 。更改用户空间接口的补丁应该抄送
86-
85+
请参阅 Documentation/admin-guide/abi.rst (或 ``Documentation/ABI/README``)。
86+
更改用户空间接口的补丁应该抄送 [email protected]\
8787

8888
19) 已通过至少注入slab和page分配失败进行检查。请参阅 ``Documentation/fault-injection/`` 。
8989
如果新代码是实质性的,那么添加子系统特定的故障注入可能是合适的。

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ Linux內核補丁提交檢查單
8585
17) 所有新的模塊參數都記錄在 ``MODULE_PARM_DESC()``
8686

8787
18) 所有新的用戶空間接口都記錄在 ``Documentation/ABI/`` 中。有關詳細信息,
88-
請參閱 Documentation/ABI/README 。更改用戶空間接口的補丁應該抄送
89-
88+
請參閱 Documentation/admin-guide/abi.rst (或 ``Documentation/ABI/README``)。
89+
更改用戶空間接口的補丁應該抄送 [email protected]\
9090

9191
19) 已通過至少注入slab和page分配失敗進行檢查。請參閱 ``Documentation/fault-injection/`` 。
9292
如果新代碼是實質性的,那麼添加子系統特定的故障注入可能是合適的。

0 commit comments

Comments
 (0)