netdev - Re: [RFC PATCH net-next v1 11/11] drivers/net/ethernet: clean up mis-targeted comments

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: <e2e637ae-8cda-c9a4-91ce-93dbd475fc0c@solarflare.com>
Date:   Fri, 11 Sep 2020 22:55:54 +0100
From:   Edward Cree <ecree@...arflare.com>
To:     Jesse Brandeburg <jesse.brandeburg@...el.com>
CC:     <netdev@...r.kernel.org>, <intel-wired-lan@...ts.osuosl.org>
Subject: Re: [RFC PATCH net-next v1 11/11] drivers/net/ethernet: clean up
 mis-targeted comments

On 11/09/2020 22:42, Jesse Brandeburg wrote:
> Thanks Ed, I think I might just remove the /** on that function then
> (removing it from kdoc processing)
I dunno, that means
a) kerneldoc won't generate html for this struct
b) new additions to the struct without corresponding kerneldoc won't
   generate warnings
 both of which are not ideal outcomes.
I realise there's value in having totally warning-clean code, but in
 this case I think this one warning, even though it's indicating a
 toolchain problem rather than a codebase problem, should better stay
 (if only to put pressure on the toolchain to fix it).
Otherwise, when and if the toolchain is fixed, what's the chance we'll
 remember to put the /** back?

That's just my opinion, though; I won't block patches that disagree.

-ed