From: "Russell King (Oracle)" <linux@armlinux.org.uk>
To: Oleksij Rempel <o.rempel@pengutronix.de>
Cc: "David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.com>,
Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>,
Andrew Lunn <andrew+netdev@lunn.ch>,
Heiner Kallweit <hkallweit1@gmail.com>,
Jonathan Corbet <corbet@lwn.net>,
kernel@pengutronix.de, linux-kernel@vger.kernel.org,
netdev@vger.kernel.org, Simon Horman <horms@kernel.org>,
Maxime Chevallier <maxime.chevallier@bootlin.com>,
linux-doc@vger.kernel.org
Subject: Re: [PATCH net-next v1 1/1] net: phy: Move callback comments from struct to kernel-doc section
Date: Fri, 6 Dec 2024 12:14:13 +0000 [thread overview]
Message-ID: <Z1LqlaG1IDvuz9Gy@shell.armlinux.org.uk> (raw)
In-Reply-To: <20241206113952.406311-1-o.rempel@pengutronix.de>
On Fri, Dec 06, 2024 at 12:39:52PM +0100, Oleksij Rempel wrote:
> Relocate all callback-related comments from the `struct phy_driver`
> definition to a dedicated `kernel-doc` section. This improves code
> readability by decluttering the structure definition and consolidating
> callback documentation in a central place for kernel-doc generation.
>
> No functional changes are introduced by this patch.
>
> Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
Thanks for doing this. This will mean that each method will be properly
documented in the generated kernel-doc.
It is a bit obtuse to work around kernel-doc in this way, but worth it
for the sake of the generated documentation containing all the pertinent
details.
Reviewed-by: Russell King (Oracle) <rmk+kernel@armlinux.org.uk>
Thanks!
--
RMK's Patch system: https://www.armlinux.org.uk/developer/patches/
FTTP is here! 80Mbps down 10Mbps up. Decent connectivity at last!
next prev parent reply other threads:[~2024-12-06 12:14 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-12-06 11:39 [PATCH net-next v1 1/1] net: phy: Move callback comments from struct to kernel-doc section Oleksij Rempel
2024-12-06 12:14 ` Russell King (Oracle) [this message]
2024-12-07 20:38 ` Andrew Lunn
2024-12-10 11:56 ` Paolo Abeni
2024-12-10 14:02 ` Russell King (Oracle)
2024-12-10 14:37 ` Jakub Kicinski
2024-12-16 12:20 ` Oleksij Rempel
2024-12-17 1:53 ` Jakub Kicinski
2024-12-17 5:40 ` Oleksij Rempel
2024-12-17 15:03 ` Jakub Kicinski
2025-01-02 16:56 ` Russell King (Oracle)
2025-01-02 18:01 ` Jonathan Corbet
2025-01-02 18:28 ` Russell King (Oracle)
2024-12-10 12:03 ` Mateusz Polchlopek
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=Z1LqlaG1IDvuz9Gy@shell.armlinux.org.uk \
--to=linux@armlinux.org.uk \
--cc=andrew+netdev@lunn.ch \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=hkallweit1@gmail.com \
--cc=horms@kernel.org \
--cc=kernel@pengutronix.de \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=maxime.chevallier@bootlin.com \
--cc=netdev@vger.kernel.org \
--cc=o.rempel@pengutronix.de \
--cc=pabeni@redhat.com \
/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.