netdev - Re: [PATCH net-next v4 01/12] inet: homa: define user-visible API for Homa

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: <93052a8a-826e-49a1-b5d3-3fbdc0f26c41@intel.com>
Date: Thu, 19 Dec 2024 22:57:04 +0100
From: Przemek Kitszel <przemyslaw.kitszel@...el.com>
To: Jakub Kicinski <kuba@...nel.org>, John Ousterhout <ouster@...stanford.edu>
CC: <netdev@...r.kernel.org>, <pabeni@...hat.com>, <edumazet@...gle.com>,
	<horms@...nel.org>
Subject: Re: [PATCH net-next v4 01/12] inet: homa: define user-visible API for
 Homa

On 12/19/24 02:43, Jakub Kicinski wrote:
> On Mon, 16 Dec 2024 16:06:14 -0800 John Ousterhout wrote:


>> + * define HOMA_MIN_DEFAULT_PORT - The 16-bit port space is divided into
>> + * two nonoverlapping regions. Ports 1-32767 are reserved exclusively
>> + * for well-defined server ports. The remaining ports are used for client
>> + * ports; these are allocated automatically by Homa. Port 0 is reserved.
>> + */
>> +#define HOMA_MIN_DEFAULT_PORT 0x8000
> 
> Not sure why but ./scripts/kernel-doc does not like this:
> 
> include/uapi/linux/homa.h:51: warning: expecting prototype for HOMA_MIN_DEFAULT_PORT - The 16(). Prototype was for HOMA_MIN_DEFAULT_PORT() instead
> 


>> +/**
>> + * define HOMA_FLAG_DONT_THROTTLE - disable the output throttling mechanism:
>> + * always send all packets immediately.
>> + */
> 
> Also makes kernel-doc unhappy:
> 
> include/uapi/linux/homa.h:159: warning: expecting prototype for HOMA_FLAG_DONT_THROTTLE - disable the output throttling mechanism(). Prototype was for HOMA_FLAG_DONT_THROTTLE() instead
> 
> Note that next patch adds more kernel-doc warnings, you probably want
> to TAL at those as well. Use
> 
>    ./scripts/kernel-doc -none -Wall $file
> 
turns out that when you have the word "define" at the front
and then a colon (:) or two dashes (-) it complains (?!!)

my advice is to remove the word "define" from the first kdoc line,
as it does not happen to bring any value (the emitted doc still has
a "function" instead of "define" used as a type)