Re: [PATCH net-next v14 22/22] testing/selftests: add test tool and scripts for ovpn module

[Antonio Quartulli <antonio@openvpn.net>]

On 10/12/2024 17:47, Simon Horman wrote:
> On Mon, Dec 09, 2024 at 09:53:31AM +0100, Antonio Quartulli wrote:
>> The ovpn-cli tool can be compiled and used as selftest for the ovpn
>> kernel module.
>>
>> [NOTE: it depends on libmedtls for decoding base64-encoded keys]
>>
>> ovpn-cli implements the netlink and RTNL APIs and can thus be integrated
>> in any script for more automated testing.
>>
>> Along with the tool, 4 scripts are provided that perform basic
>> functionality tests by means of network namespaces.
>> These scripts take part to the kselftest automation.
>>
>> The output of the scripts, which will appear in the kselftest
>> reports, is a list of steps performed by the scripts plus some
>> output coming from the execution of `ping`, `iperf` and `ovpn-cli`
>> itself.
>> In general it is useful only in case of failure, in order to
>> understand which step has failed and why.
>>
>> Cc: linux-kselftest@vger.kernel.org
>> Signed-off-by: Antonio Quartulli <antonio@openvpn.net>
>> Reviewed-by: Shuah Khan <skhan@linuxfoundation.org>
> 
> ...
> 
>> +/**
>> + * Helper function used to easily add attributes to a rtnl message
>> + */
> 
> Hi Antonio,
> 
> This comment starts with a '/**' but is otherwise not formatted as
> a Kernel doc. Probably it is best to simply start the comment with '/*'.
> 
> Likewise elsewhere in this patch.

Will fix all instances of this issue.

> 
> Flagged by ./scripts/kernel-doc -none

Darn, I have been running kernel-doc only against drivers/net/ovpn.
Thanks for pointing this out.

Regards,

> 
>> +static int ovpn_addattr(struct nlmsghdr *n, int maxlen, int type,
>> +			const void *data, int alen)
> 
> ...

-- 
Antonio Quartulli
OpenVPN Inc.