[PATCH] docs: Remove literal markup from Documentation/ paths

SeongJae Park sj at kernel.org
Fri Apr 4 10:43:39 PDT 2025


On Fri, 04 Apr 2025 11:37:28 -0400 Nícolas F. R. A. Prado <nfraprado at collabora.com> 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 <nfraprado at collabora.com>

Acked-by: SeongJae Park <sj at kernel.org>


Thanks,
SJ

[...]



More information about the linux-um mailing list