From: Jesper Dangaard Brouer <hawk@kernel.org>
To: Jakub Kicinski <kuba@kernel.org>, davem@davemloft.net
Cc: netdev@vger.kernel.org, edumazet@google.com, pabeni@redhat.com,
aleksander.lobakin@intel.com, ilias.apalodimas@linaro.org,
corbet@lwn.net, linux-doc@vger.kernel.org,
Lorenzo Bianconi <lorenzo@kernel.org>,
Randy Dunlap <rdunlap@infradead.org>
Subject: Re: [PATCH net-next v2 2/2] docs: net: page_pool: use kdoc to avoid duplicating the information
Date: Thu, 3 Aug 2023 09:08:55 +0200 [thread overview]
Message-ID: <350a2ae8-8942-20b9-e449-6047b2272b4e@kernel.org> (raw)
In-Reply-To: <20230802161821.3621985-3-kuba@kernel.org>
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@kernel.org>
This is great! :-)
Acked-by: Jesper Dangaard Brouer <hawk@kernel.org>
next prev parent reply other threads:[~2023-08-03 7:09 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-08-02 16:18 [PATCH net-next v2 0/2] docs: net: page_pool: sync dev and kdoc Jakub Kicinski
2023-08-02 16:18 ` [PATCH net-next v2 1/2] docs: net: page_pool: document PP_FLAG_DMA_SYNC_DEV parameters Jakub Kicinski
2023-08-03 3:17 ` Randy Dunlap
2023-08-03 6:30 ` Michael Chan
2023-08-03 7:04 ` Jesper Dangaard Brouer
2023-08-03 9:35 ` Somnath Kotur
2023-08-02 16:18 ` [PATCH net-next v2 2/2] docs: net: page_pool: use kdoc to avoid duplicating the information Jakub Kicinski
2023-08-03 3:17 ` Randy Dunlap
2023-08-03 7:08 ` Jesper Dangaard Brouer [this message]
2023-08-03 17:10 ` [PATCH net-next v2 0/2] docs: net: page_pool: sync dev and kdoc patchwork-bot+netdevbpf
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=350a2ae8-8942-20b9-e449-6047b2272b4e@kernel.org \
--to=hawk@kernel.org \
--cc=aleksander.lobakin@intel.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=ilias.apalodimas@linaro.org \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=lorenzo@kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=rdunlap@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.