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

Patch content 6 changed files

Commit fb12098d8ee4 ("docs: submit-checklist: Allow creatingcross-references for ABI README") assumes that the path of"Documentation/ABI/README" would be converted to a cross-ref tothe README. However, as the README is included by the "kernel-abi" directiveat Documentation/admin-guide/abi.rst, the expected conversiondoes not happen. Instead, use the path where the "kernel-abi" directive exists forthe conversion to work.  Restore the original path of README ininline-literal form as an additional note for readers of the .rstfile. 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>---Hi mauro, Having failed to get a response to my question at:    https://lore.kernel.org/b464e845-a83e-421b-aeeb-6a9ee36afbbf@gmail.com/         "Mauro, this change does not result in cross reference to the README page.    Not only here, but the change in Documentation/process/submit-checklist.rst    does not work either.     What was your intention of commit fb12098d8ee4 ("docs: submit-checklist:    Allow creating cross-references for ABI README")?" , I have gone forward and prepared this "band-aid" update. I don't think this is your original intention, so please feel free tooverride this if you'd like to. Note on zh_CN and zh_TW changes: I intentionally used ascii "( )" so that inline literall is recognizedby Sphinx without extra spaces.Another trick is the escaped space at end-of-sentence as in "...org\ 。",which prevents unneeded white spaces from appearing in front of thefull stop in the html output.         Thanks, Akira-- Documentation/process/submit-checklist.rst                 | 3 ++- .../translations/it_IT/process/submit-checklist.rst        | 7 ++++--- .../translations/ja_JP/process/submit-checklist.rst        | 3 ++- .../translations/sp_SP/process/submit-checklist.rst        | 7 ++++--- .../translations/zh_CN/process/submit-checklist.rst        | 4 ++-- .../translations/zh_TW/process/submit-checklist.rst        | 4 ++-- 6 files changed, 16 insertions(+), 12 deletions(-) diff --git a/Documentation/process/submit-checklist.rst b/Documentation/process/submit-checklist.rstindex 2abf8831cf74..beb7f94279fd 100644--- a/Documentation/process/submit-checklist.rst+++ b/Documentation/process/submit-checklist.rst@@ -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. diff --git a/Documentation/translations/it_IT/process/submit-checklist.rst b/Documentation/translations/it_IT/process/submit-checklist.rstindex 3308c3084c60..5bf1b4adebc1 100644--- a/Documentation/translations/it_IT/process/submit-checklist.rst+++ b/Documentation/translations/it_IT/process/submit-checklist.rst@@ -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``.diff --git a/Documentation/translations/ja_JP/process/submit-checklist.rst b/Documentation/translations/ja_JP/process/submit-checklist.rstindex 20a952cf82f9..fb3b9e3bd8ee 100644--- a/Documentation/translations/ja_JP/process/submit-checklist.rst+++ b/Documentation/translations/ja_JP/process/submit-checklist.rst@@ -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 すべし。 diff --git a/Documentation/translations/sp_SP/process/submit-checklist.rst b/Documentation/translations/sp_SP/process/submit-checklist.rstindex 3087ba80e818..e7107cc97001 100644--- a/Documentation/translations/sp_SP/process/submit-checklist.rst+++ b/Documentation/translations/sp_SP/process/submit-checklist.rst@@ -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/``.diff --git a/Documentation/translations/zh_CN/process/submit-checklist.rst b/Documentation/translations/zh_CN/process/submit-checklist.rstindex 5c20a7f0936b..0e524f1c1af5 100644--- a/Documentation/translations/zh_CN/process/submit-checklist.rst+++ b/Documentation/translations/zh_CN/process/submit-checklist.rst@@ -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/`` 。     如果新代码是实质性的，那么添加子系统特定的故障注入可能是合适的。diff --git a/Documentation/translations/zh_TW/process/submit-checklist.rst b/Documentation/translations/zh_TW/process/submit-checklist.rstindex b09d29b0cc1b..a0cb91a6945f 100644--- a/Documentation/translations/zh_TW/process/submit-checklist.rst+++ b/Documentation/translations/zh_TW/process/submit-checklist.rst@@ -85,8 +85,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/`` 。     如果新代碼是實質性的，那麼添加子系統特定的故障注入可能是合適的。 base-commit: 76a6782284dff53a08b688fdead3e46f22236e71-- 2.34.1