linux-kernel - Re: [PATCH] docs: dev-tools: checkpatch: Add targets for checkpatch tags

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: <10035992.Dr8D0Bp7vt@bagend>
Date: Mon, 13 May 2024 15:45:35 +0200
From: Diederik de Haas <didi.debian@...ow.org>
To: Jani Nikula <jani.nikula@...ux.intel.com>,
 Lukas Bulwahn <lukas.bulwahn@...il.com>
Cc: Dwaipayan Ray <dwaipayanray1@...il.com>, Joe Perches <joe@...ches.com>,
 Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org
Subject:
 Re: [PATCH] docs: dev-tools: checkpatch: Add targets for checkpatch tags

On Monday, 13 May 2024 13:46:39 CEST Lukas Bulwahn wrote:
> On Mon, May 13, 2024 at 1:18 PM Jani Nikula <jani.nikula@...ux.intel.com> 
wrote:
> > On Mon, 13 May 2024, Diederik de Haas <didi.debian@...ow.org> wrote:
> > > Make the tags directly linkable by defining targets for them.
> > > 
> > > Closes: https://lore.kernel.org/r/8090211.0vHzs8tI1a@bagend/
> > > Signed-off-by: Diederik de Haas <didi.debian@...ow.org>
> > > ---
> > > 
> > >  Documentation/dev-tools/checkpatch.rst | 216 +++++++++++++++++++++++++
> > >  1 file changed, 216 insertions(+)
> > > 
> > > diff --git a/Documentation/dev-tools/checkpatch.rst
> > > b/Documentation/dev-tools/checkpatch.rst index
> > > 127968995847..6499e29c3a19 100644
> > > --- a/Documentation/dev-tools/checkpatch.rst
> > > +++ b/Documentation/dev-tools/checkpatch.rst
> > > @@ -242,6 +242,8 @@ This section contains a description of all the
> > > message types in checkpatch.> > 
> > >  Allocation style
> > >  ----------------
> > > 
> > > +  .. _alloc-array-args:
> > > +
> > > 
> > >    **ALLOC_ARRAY_ARGS**
> > 
> > Alternatively, you could just convert the definition lists into section
> > titles to make them implicit hyperlink targets. The rst stays cleaner
> > and there's no manual updating.

Yeah, makes sense.

Indented boldface letters (as it is now), stands out visually much more then 
an ``<h4>`` header (tried it with "^ for subsubsections").

Is being able to use URLs/Links like this:
https://docs.kernel.org/dev-tools/checkpatch.html#BAD_FIXES_TAG

considered worth the (visual) trade-off?

> Agree with Jani. It is important to check that the verbose option of
> the checkpatch still works. The script actually parses the
> documentation and then shows the relevant parts as verbose output to
> the user. It currently relies on the specific format, but it is not
> difficult to change that to use a different pattern, see sub load_docs
> in checkpatch.pl.
> 
> So, please make sure the current --verbose option in checkpatch.pl
> does not break.

It's a bit more challenging for me being (mostly) clueless about Perl.

Cheers,
  Diederik
Download attachment "signature.asc" of type "application/pgp-signature" (229 bytes)