linux-kernel - Re: [PATCH] docs: Add more message type documentations for checkpatch

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] [day] [month] [year] [list]

Message-ID: <87y2c9m8w5.fsf@meer.lwn.net>
Date:   Thu, 20 May 2021 14:45:46 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Dwaipayan Ray <dwaipayanray1@...il.com>
Cc:     Mauro Carvalho Chehab <mchehab@...nel.org>,
        linux-kernel <linux-kernel@...r.kernel.org>,
        Lukas Bulwahn <lukas.bulwahn@...il.com>,
        "open list:DOCUMENTATION" <linux-doc@...r.kernel.org>,
        Joe Perches <joe@...ches.com>
Subject: Re: [PATCH] docs: Add more message type documentations for checkpatch

Dwaipayan Ray <dwaipayanray1@...il.com> writes:

> (Adding Joe for comments)
>
>> We really shouldn't be linking to outside sites - even kernel.org - when
>> referring to the kernel docs themselves.  Just say
>> "Documentation/timers/timers-howto" and let the build system handle the
>> links.
>>
>> There's a lot of these in this file, alas...
>>
>> I've applied this patch since it makes things better overall, but I
>> would really like to see all those URLs go away if possible.
>>
>
> Thanks Jonathan.
>
> Yes it might make things better for the documentation, but again
> since we are using these descriptions in checkpatch's --verbose mode,
> we shall lose the ability to show the links there which I think is currently
> a good addition for the end user.
>
> And I don't think there will be a way to generate these links in checkpatch
> without sphinx's build system....

Ah, OK, I wasn't thinking about that aspect of things; that does change
the situation a bit.

It wouldn't be that hard to do an equivalent of the automarkup magic in
checkpatch to create the relevant links, but I'm not so set on this as
to try to require that.  The links can be as they are, sorry for the
noise.

Thanks,

jon