From: Oleksij Rempel <o.rempel@pengutronix.de>
To: Jakub Kicinski <kuba@kernel.org>
Cc: "Russell King (Oracle)" <linux@armlinux.org.uk>,
Paolo Abeni <pabeni@redhat.com>,
"David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.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: Mon, 16 Dec 2024 13:20:22 +0100 [thread overview]
Message-ID: <Z2AbBilPf2JRXNzH@pengutronix.de> (raw)
In-Reply-To: <20241210063704.09c0ac8a@kernel.org>
Hi Jakub,
On Tue, Dec 10, 2024 at 06:37:04AM -0800, Jakub Kicinski wrote:
> > I certainly can't help but write the "returns" statement in natural
> > English, rather than kernel-doc "Returns:" style as can be seen from
> > my recent patches that have been merged. "Returns" without a colon is
> > just way more natural when writing documentation.
> >
> > IMHO, kernel-doc has made a wrong decision by requiring the colon.
>
> For the patch under consideration, however, I think _some_ attempt
> to make fully documenting callbacks inline possible needs to be made :(
Please rephrase, I do not understand.
Should I resend this patch with corrected "Return:" description, or
continue with inlined comments withing the struct and drop this patch?
Regards,
Oleksij
--
Pengutronix e.K. | |
Steuerwalder Str. 21 | http://www.pengutronix.de/ |
31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
next prev parent reply other threads:[~2024-12-16 12:20 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)
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 [this message]
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=Z2AbBilPf2JRXNzH@pengutronix.de \
--to=o.rempel@pengutronix.de \
--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=linux@armlinux.org.uk \
--cc=maxime.chevallier@bootlin.com \
--cc=netdev@vger.kernel.org \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).