From: Andrew Lunn <andrew@lunn.ch>
To: Jeff Johnson <quic_jjohnson@quicinc.com>
Cc: "Russell King (Oracle)" <linux@armlinux.org.uk>,
Jakub Kicinski <kuba@kernel.org>,
Christian Marangi <ansuelsmth@gmail.com>,
Florian Fainelli <florian.fainelli@broadcom.com>,
Broadcom internal kernel review list
<bcm-kernel-feedback-list@broadcom.com>,
Heiner Kallweit <hkallweit1@gmail.com>,
"David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.com>,
Paolo Abeni <pabeni@redhat.com>,
David Epping <david.epping@missinglinkelectronics.com>,
Vladimir Oltean <olteanv@gmail.com>,
Harini Katakam <harini.katakam@amd.com>,
netdev@vger.kernel.org, linux-kernel@vger.kernel.org,
workflows@vger.kernel.org
Subject: Re: [net-next PATCH v3 3/3] net: phy: add support for PHY package MMD read/write
Date: Tue, 5 Dec 2023 21:11:00 +0100 [thread overview]
Message-ID: <a3572abc-b49a-44e7-b36c-cf462bcc09ac@lunn.ch> (raw)
In-Reply-To: <91dcd8c3-ae86-4350-838d-62ddb62fa2bb@quicinc.com>
> Having worked with closed-source systems, especially VxWorks, for many
> years (where the header files contain all the documentation), it just
> seems strange to embed the documentation in the .c files.
The key words here might be closed-source. With such black boxes, you
don't have access the sources. You cannot look at the source to
understand how a function works. In the open source world, the
comments partially function as an introduction to reading the code and
understanding what it does. You are also encouraged to change the code
if needed, which in the closed source world you cannot do.
Given this discussion, i now think putting the documentation in the .c
file makes more sense. For the generated documentation it does not
matter, but for the reader of the code, having it in the .c files does
seem to make sense.
Andrew
prev parent reply other threads:[~2023-12-05 20:11 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20231128133630.7829-1-ansuelsmth@gmail.com>
[not found] ` <20231128133630.7829-3-ansuelsmth@gmail.com>
[not found] ` <20231204181752.2be3fd68@kernel.org>
[not found] ` <51aae9d0-5100-41af-ade0-ecebeccbc418@lunn.ch>
[not found] ` <656f37a6.5d0a0220.96144.356f@mx.google.com>
[not found] ` <adbe5299-de4a-4ac1-90d0-f7ae537287d0@lunn.ch>
[not found] ` <ZW89errbJWUt33vz@shell.armlinux.org.uk>
2023-12-05 15:29 ` [net-next PATCH v3 3/3] net: phy: add support for PHY package MMD read/write Jakub Kicinski
2023-12-05 16:11 ` Russell King (Oracle)
2023-12-05 17:44 ` Jeff Johnson
2023-12-05 18:14 ` Russell King (Oracle)
2023-12-05 19:58 ` Jeff Johnson
2023-12-05 20:11 ` Andrew Lunn [this message]
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=a3572abc-b49a-44e7-b36c-cf462bcc09ac@lunn.ch \
--to=andrew@lunn.ch \
--cc=ansuelsmth@gmail.com \
--cc=bcm-kernel-feedback-list@broadcom.com \
--cc=davem@davemloft.net \
--cc=david.epping@missinglinkelectronics.com \
--cc=edumazet@google.com \
--cc=florian.fainelli@broadcom.com \
--cc=harini.katakam@amd.com \
--cc=hkallweit1@gmail.com \
--cc=kuba@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@armlinux.org.uk \
--cc=netdev@vger.kernel.org \
--cc=olteanv@gmail.com \
--cc=pabeni@redhat.com \
--cc=quic_jjohnson@quicinc.com \
--cc=workflows@vger.kernel.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 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 read-only IMAP folder(s) and NNTP newsgroup(s).