netdev - Re: [PATCH v2 net-next] Documentation: update networking/page

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: <20220607210021.05263978@kernel.org>
Date:   Tue, 7 Jun 2022 21:00:21 -0700
From:   Jakub Kicinski <kuba@...nel.org>
To:     Lorenzo Bianconi <lorenzo@...nel.org>
Cc:     netdev@...r.kernel.org, ilias.apalodimas@...aro.org,
        hawk@...nel.org, davem@...emloft.net, edumazet@...gle.com,
        pabeni@...hat.com, corbet@....net, linux-doc@...r.kernel.org,
        jbrouer@...hat.com, lorenzo.bianconi@...hat.com
Subject: Re: [PATCH v2 net-next] Documentation: update
 networking/page_pool.rst with ethtool APIs

On Mon,  6 Jun 2022 22:15:45 +0200 Lorenzo Bianconi wrote:
> Update page_pool documentation with page_pool ethtool stats APIs.
> 
> Signed-off-by: Lorenzo Bianconi <lorenzo@...nel.org>
> ---
> Changes since v1:
> - get rid of literal markup

This is not what Andrew and I meant, I don't think. The suggestion was
to put the information in kdoc of the function, in the source code, and
then render the kdoc here by adding something like:

.. kernel-doc:: whatever/the/source/is.c
   :identifiers: page_pool_ethtool_stats_get_strings page_pool_ethtool_stats_get_count page_pool_ethtool_stats_get