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

Diederik de Haas
2024-05-13T13:45:49Z

[-- Attachment #1: Type: text/plain, Size: 2162 bytes --]

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@linux.intel.com>
wrote:
> > On Mon, 13 May 2024, Diederik de Haas <didi.debian@cknow.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@cknow.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 `` `` 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

[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 228 bytes --]