netdev - Re: [PATCH v3 12/17] wifi: cc33xx: Add scan.c, scan.h

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: <33f3b6a4-f907-4374-90ac-d81a81700936@ti.com>
Date: Mon, 28 Oct 2024 18:26:50 +0200
From: "Nemanov, Michael" <michael.nemanov@...com>
To: Simon Horman <horms@...nel.org>
CC: Kalle Valo <kvalo@...nel.org>, "David S. Miller" <davem@...emloft.net>,
        Eric Dumazet <edumazet@...gle.com>, Jakub Kicinski <kuba@...nel.org>,
        Paolo
 Abeni <pabeni@...hat.com>, Rob Herring <robh@...nel.org>,
        Krzysztof Kozlowski
	<krzk+dt@...nel.org>,
        Conor Dooley <conor+dt@...nel.org>, <linux-wireless@...r.kernel.org>,
        <netdev@...r.kernel.org>, <devicetree@...r.kernel.org>,
        <linux-kernel@...r.kernel.org>, Sabeeh Khan
	<sabeeh-khan@...com>
Subject: Re: [PATCH v3 12/17] wifi: cc33xx: Add scan.c, scan.h

On 8/9/2024 7:03 PM, Simon Horman wrote:
> On Tue, Aug 06, 2024 at 08:00:13PM +0300, Michael Nemanov wrote:
> 
> ...
> 
>> diff --git a/drivers/net/wireless/ti/cc33xx/scan.h b/drivers/net/wireless/ti/cc33xx/scan.h
> 
> ...
> 
>> +/**
>> + * struct cc33xx_cmd_ssid_list - scan SSID list description
>> + *
>> + * @role_id:            roleID
>> + *
>> + * @num_of_ssids:       Number of SSID in the list. MAX 16 entries
> 
> @num_of_ssids -> @n_ssids
> 
>> + *
>> + * @ssid_list:          SSIDs to scan for (active scan only)
> 
> @ssid_list -> @ssids
 >

Thanks for the feedback, will fix.

> Please document all non-private fields,
> and annotate those that are private.
> 

Not sure I follow. You mean mark private vs. non private members in the 
documentation? If so, private to what (the CC33xx driver or the 
underlying HW)?

> There are a number of similar minor Kernel doc problems with this patch.
> Please consider using W=1 builds or ./scripts/kernel-doc -none
> (bonus points for -Wall)
> 

Ran both, got warning for "no structured comments found" on multiple 
files. Is that it?

Thanks and regards,
Michael.