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]

Date: Mon, 13 May 2024 20:51:31 +0900
From: Akira Yokosawa <akiyks@...il.com>
To: jani.nikula@...ux.intel.com, didi.debian@...ow.org
Cc: corbet@....net, dwaipayanray1@...il.com, joe@...ches.com,
 linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 lukas.bulwahn@...il.com, Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH] docs: dev-tools: checkpatch: Add targets for checkpatch
 tags

On Mon, 13 May 2024 14:18:28 +0300, Jani Nikula 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.
> 

+1

I misread Diederik's intention and thought he wanted that single target
he mentioned in the other thread.

I believe Jani's suggestion is the right way going forward.

        Thanks, Akira

> BR,
> Jani.
[snip]