Re: [PATCH net-next v3 00/24] Introducing OpenVPN Data Channel Offload

Antonio Quartulli
2024-05-08T09:55:31Z

On 08/05/2024 01:48, Jakub Kicinski wrote:
> On Mon, 6 May 2024 03:16:13 +0200 Antonio Quartulli wrote:
>> I am finally back with version 3 of the ovpn patchset.
>> It took a while to address all comments I have received on v2, but I
>> am happy to say that I addressed 99% of the feedback I collected.
>
> Nice, one more check / warning that pops up is missing kdoc.
> W=1 build only catches kdoc problems in C sources, for headers
> try running something like:
>
> ./scripts/kernel-doc -none -Wall $new_files

I see there is one warning to fix due to a typ0 (eventS_wq vs event_wq),
but I also get more warnings like this:

drivers/net/ovpn/peer.h:119: warning: Function parameter or struct
member 'vpn_addrs' not described in 'ovpn_peer'

However vpn_addrs is an anonymous struct within struct ovpn_peer.
I have already documented all its members using the form:

@vpn_addrs.ipv4
@vpn_addrs.ipv6

Am I expected to document the vpn_addrs as well?
Or is this a false positive?

Regards,

--
Antonio Quartulli
OpenVPN Inc.