netdev - Re: [PATCH net-next v2 2/2] docs: net: page_pool: use kdoc to avoid duplicating the information

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: <350a2ae8-8942-20b9-e449-6047b2272b4e@kernel.org>
Date: Thu, 3 Aug 2023 09:08:55 +0200
From: Jesper Dangaard Brouer <hawk@...nel.org>
To: Jakub Kicinski <kuba@...nel.org>, davem@...emloft.net
Cc: netdev@...r.kernel.org, edumazet@...gle.com, pabeni@...hat.com,
 aleksander.lobakin@...el.com, ilias.apalodimas@...aro.org, corbet@....net,
 linux-doc@...r.kernel.org, Lorenzo Bianconi <lorenzo@...nel.org>,
 Randy Dunlap <rdunlap@...radead.org>
Subject: Re: [PATCH net-next v2 2/2] docs: net: page_pool: use kdoc to avoid
 duplicating the information



On 02/08/2023 18.18, Jakub Kicinski wrote:
> All struct members of the driver-facing APIs are documented twice,
> in the code and under Documentation. This is a bit tedious.
> 
> I also get the feeling that a lot of developers will read the header
> when coding, rather than the doc. Bring the two a little closer
> together by using kdoc for structs and functions.
> 
> Using kdoc also gives us links (mentioning a function or struct
> in the text gets replaced by a link to its doc).
> 
> Signed-off-by: Jakub Kicinski<kuba@...nel.org>

This is great! :-)

Acked-by: Jesper Dangaard Brouer <hawk@...nel.org>