linux-kernel - Re: [PATCH] docs: Remove literal markup from Documentation/ paths

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20250405163158.55935fdf@jic23-huawei>
Date: Sat, 5 Apr 2025 16:31:58 +0100
From: Jonathan Cameron <jic23@...nel.org>
To: Jonathan Corbet <corbet@....net>
Cc: Jonathan Cameron <Jonathan.Cameron@...wei.com>, "Nícolas F. R. A. Prado" <nfraprado@...labora.com>, Andrew Morton
 <akpm@...ux-foundation.org>, Vinod Koul <vkoul@...nel.org>, Eric Biggers
 <ebiggers@...nel.org>, "Theodore Y. Ts'o" <tytso@....edu>, Jaegeuk Kim
 <jaegeuk@...nel.org>, Lars-Peter Clausen <lars@...afoo.de>, "David S.
 Miller" <davem@...emloft.net>, Eric Dumazet <edumazet@...gle.com>, Jakub
 Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>, Simon Horman
 <horms@...nel.org>, Maxime Chevallier <maxime.chevallier@...tlin.com>,
 James Bottomley <James.Bottomley@...senPartnership.com>, Jarkko Sakkinen
 <jarkko@...nel.org>, Mimi Zohar <zohar@...ux.ibm.com>, Jaroslav Kysela
 <perex@...ex.cz>, Takashi Iwai <tiwai@...e.com>, Mauro Carvalho Chehab
 <mchehab@...nel.org>, Richard Weinberger <richard@....at>, Anton Ivanov
 <anton.ivanov@...bridgegreys.com>, Johannes Berg
 <johannes@...solutions.net>, kernel@...labora.com, linux-mm@...ck.org,
 linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 dmaengine@...r.kernel.org, linux-fscrypt@...r.kernel.org,
 linux-iio@...r.kernel.org, netdev@...r.kernel.org,
 workflows@...r.kernel.org, linux-integrity@...r.kernel.org,
 keyrings@...r.kernel.org, linux-sound@...r.kernel.org,
 linux-media@...r.kernel.org, linux-um@...ts.infradead.org
Subject: Re: [PATCH] docs: Remove literal markup from Documentation/ paths

On Fri, 04 Apr 2025 11:42:54 -0600
Jonathan Corbet <corbet@....net> wrote:

> Jonathan Cameron <Jonathan.Cameron@...wei.com> writes:
> 
> > On Fri, 04 Apr 2025 11:37:28 -0400
> > Nícolas F. R. A. Prado <nfraprado@...labora.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@...labora.com>
> >> ---
> >>  Documentation/admin-guide/mm/numa_memory_policy.rst       | 2 +-
> >>  Documentation/admin-guide/serial-console.rst              | 2 +-
> >>  Documentation/driver-api/dmaengine/client.rst             | 2 +-
> >>  Documentation/driver-api/nvdimm/security.rst              | 2 +-
> >>  Documentation/filesystems/fscrypt.rst                     | 4 ++--
> >>  Documentation/iio/adis16475.rst                           | 4 ++--
> >>  Documentation/iio/adis16480.rst                           | 4 ++--
> >>  Documentation/iio/adis16550.rst                           | 4 ++--
> >>  Documentation/iio/adxl380.rst                             | 4 ++--  
> >
> > Split patch up by subsystem would be a good thing here as we may
> > get other changes to these docs during the cycle and resulting
> > merge conflicts if this all goes in as one patch.  
> 
> That seems like a way to add a significant amount of pain to a basic
> (but indeed useful) cleanup patch like this.  If the relevant
> maintainers insist on it then that's how it has to be done, but I bet I
> could just take the whole thing through docs with almost no trouble.
> 
hmm.  I'll go with maybe. Let's cross fingers then.

Acked-by: Jonathan Cameron <Jonathan.Cameron@...wei.com>

> jon