netdev - Re: [PATCH net-next v2 09/10] sfc: fix kdoc warning

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:   Tue, 15 Sep 2020 10:05:59 +0100
From:   Edward Cree <ecree@...arflare.com>
To:     Jesse Brandeburg <jesse.brandeburg@...el.com>,
        <netdev@...r.kernel.org>
CC:     <intel-wired-lan@...ts.osuosl.org>
Subject: Re: [PATCH net-next v2 09/10] sfc: fix kdoc warning

On 15/09/2020 02:44, Jesse Brandeburg wrote:
> kernel-doc script as used by W=1, is confused by the macro
> usage inside the header describing the efx_ptp_data struct.
>
> drivers/net/ethernet/sfc/ptp.c:345: warning: Function parameter or member 'MC_CMD_PTP_IN_TRANSMIT_LENMAX' not described in 'efx_ptp_data'
>
> After some discussion on the list, break this patch out to
> a separate one, and fix the issue through a creative
> macro declaration.
>
> Signed-off-by: Jesse Brandeburg <jesse.brandeburg@...el.com>
> Cc: Edward Cree <ecree@...arflare.com>
I still don't love it, but it'll do, so have an
Acked-by: Edward Cree <ecree@...arflare.com>

(But please make sure whoever maintains scripts/kernel-doc knows that
 it's breaking on a reasonable construct and forcing the code to be
 _less_ self-documenting than it otherwise could be.)