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: <738565a2-4415-b67e-8955-32909cdbae83@infradead.org>
Date: Wed, 2 Aug 2023 20:17:24 -0700
From: Randy Dunlap <rdunlap@...radead.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, hawk@...nel.org, ilias.apalodimas@...aro.org,
 corbet@....net, linux-doc@...r.kernel.org,
 Lorenzo Bianconi <lorenzo@...nel.org>
Subject: Re: [PATCH net-next v2 2/2] docs: net: page_pool: use kdoc to avoid
 duplicating the information



On 8/2/23 09: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.
> 

so easier to maintain...

> 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.

Ack that.

> 
> 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>


Reviewed-by: Randy Dunlap <rdunlap@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.org>

Thanks.

> --
> CC: hawk@...nel.org
> CC: ilias.apalodimas@...aro.org
> CC: corbet@....net
> CC: linux-doc@...r.kernel.org
> CC: Lorenzo Bianconi <lorenzo@...nel.org>
> CC: Randy Dunlap <rdunlap@...radead.org>
> CC: Alexander Lobakin <aleksander.lobakin@...el.com>
> ---
>  Documentation/networking/page_pool.rst |  86 ++++------------
>  include/net/page_pool.h                | 134 +++++++++++++++++++------
>  net/core/page_pool.c                   |  31 +++++-
>  3 files changed, 152 insertions(+), 99 deletions(-)
> 


-- 
~Randy