From: Krzysztof Wilczy??ski <kw@linux.com>
To: Lukas Wunner <lukas@wunner.de>
Cc: Bjorn Helgaas <bhelgaas@google.com>,
Scott Murray <scott@spiteful.org>,
linux-pci@vger.kernel.org
Subject: Re: [PATCH v3] PCI: hotplug: Fix kernel-doc formatting and add missing documentation
Date: Sat, 3 Jul 2021 10:51:31 +0200 [thread overview]
Message-ID: <20210703085131.GA427173@rocinante> (raw)
In-Reply-To: <20210703064848.GA24279@wunner.de>
Hi Lukas,
Thank you for feedback!
[...]
> I respectfully submit that the formatting is fine and there's nothing
> to be "fixed" here (as the commit message claims).
The fixing it probably more relevant to the two first hunks, everything
else would be more of a style update so that kernel-doc is kept with the
following guideline:
https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html
Which is something other users of kernel-doc seldom embrace as I could
only find a handful of places where this format is somewhat followed.
Thus, like you say, keeping the scope of changes to only updating what
matters would be more appropriate. I will send another revision that
does exactly that.
> > + * @inband_presence_disabled: Flag to used to track whether the in-band
> > + * presence detection is disabled.
>
> That's not proper English and also not very useful because the documentation
> merely repeats what the flag's name says. I'd suggest something along the
> lines of:
> * @inband_presence_disabled: whether In-Band Presence Detect Disable is
> * supported by the controller and disabled per spec recommendation
> * (PCIe r5.0, appendix I implementation note)
Thank you! I will use your version going forward.
Krzysztof
prev parent reply other threads:[~2021-07-03 8:51 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-02 23:15 [PATCH v3] PCI: hotplug: Fix kernel-doc formatting and add missing documentation Krzysztof Wilczyński
2021-07-03 6:48 ` Lukas Wunner
2021-07-03 8:51 ` Krzysztof Wilczy??ski [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=20210703085131.GA427173@rocinante \
--to=kw@linux.com \
--cc=bhelgaas@google.com \
--cc=linux-pci@vger.kernel.org \
--cc=lukas@wunner.de \
--cc=scott@spiteful.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 NNTP newsgroup(s).