Hi,
Nícolas F. R. A. Prado wrote:
> Given that the automarkup Sphinx plugin cross-references
> "Documentation/*.rst" strings in the text to the corresponding
> documents, surrounding those strings with the literal markup (``) not
> only adds unnecessary markup in the source files, but actually prevents
> the automatic cross-referencing to happen (as it doesn't happen in
> literal blocks).
>
> Remove all the occurrences of the literal markup in
> "Documentation/*.rst" paths, except when the actual source file is being
> referred. Also change the surrounding text when needed so it reads well
> both in the source and the web page (eg. 'see file Doc...' -> 'see
> Doc...').
>
> Signed-off-by: Nícolas F. R. A. Prado <nfrapr...@collabora.com>
> ---
[...]
> Documentation/process/submit-checklist.rst | 7 ++++---
I have updated ja_JP translation of this recently.
> diff --git a/Documentation/process/submit-checklist.rst
> b/Documentation/process/submit-checklist.rst
> index
> beb7f94279fdb6a1d9b4aa86b2bea031f140732b..3ae31c5af2cb5c374658c1fb7125e70bf36e911c
> 100644
> --- a/Documentation/process/submit-checklist.rst
> +++ b/Documentation/process/submit-checklist.rst
> @@ -30,7 +30,8 @@ Review Kconfig changes
>
> 1) Any new or modified ``CONFIG`` options do not muck up the config menu and
> default to off unless they meet the exception criteria documented in
> - ``Documentation/kbuild/kconfig-language.rst`` Menu attributes: default
> value.
> + Documentation/kbuild/kconfig-language.rst, under "Menu attributes",
> "default
> + value".
I have made the same change in the translation, but failed to submit a patch...
>
> 2) All new ``Kconfig`` options have help text.
>
> @@ -47,7 +48,7 @@ Provide documentation
> 2) All new ``/proc`` entries are documented under ``Documentation/``
>
> 3) All new kernel boot parameters are documented in
> - ``Documentation/admin-guide/kernel-parameters.rst``.
> + Documentation/admin-guide/kernel-parameters.rst.
Hmm, this item is asking "Have you documented the new params in that
particular file?", so I don't think this change should be made.
>
> 4) All new module parameters are documented with ``MODULE_PARM_DESC()``
>
> @@ -58,7 +59,7 @@ Provide documentation
> linux-...@vger.kernel.org.
>
> 6) If any ioctl's are added by the patch, then also update
> - ``Documentation/userspace-api/ioctl/ioctl-number.rst``.
> + Documentation/userspace-api/ioctl/ioctl-number.rst.
Ditto.
Thanks, Akira
>
> Check your code with tools
> ==========================
