From: Richard Cochran <richardcochran@gmail.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: netdev@vger.kernel.org, kernel test robot <lkp@intel.com>,
Min Li <min.li.xe@renesas.com>,
"David S. Miller" <davem@davemloft.net>,
Jakub Kicinski <kuba@kernel.org>
Subject: Re: [PATCH v2] ptp: ptp_clockmatrix: repair non-kernel-doc comment
Date: Thu, 11 Nov 2021 18:06:03 -0800 [thread overview]
Message-ID: <20211112020603.GA464@hoboy.vegasvil.org> (raw)
In-Reply-To: <20211111155034.29153-1-rdunlap@infradead.org>
On Thu, Nov 11, 2021 at 07:50:34AM -0800, Randy Dunlap wrote:
> Do not use "/**" to begin a comment that is not in kernel-doc format.
>
> Prevents this docs build warning:
>
> drivers/ptp/ptp_clockmatrix.c:1679: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> * Maximum absolute value for write phase offset in picoseconds
>
> Then remove the kernel-doc-like function parameter descriptions
> since they don't add any useful info. (suggested by Jakub)
>
> Fixes: 794c3dffacc16 ("ptp: ptp_clockmatrix: Add support for FW 5.2 (8A34005)")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: kernel test robot <lkp@intel.com>
> Cc: Min Li <min.li.xe@renesas.com>
> Cc: Richard Cochran <richardcochran@gmail.com>
> Cc: "David S. Miller" <davem@davemloft.net>
> Cc: Jakub Kicinski <kuba@kernel.org>
Acked-by: Richard Cochran <richardcochran@gmail.com>
next prev parent reply other threads:[~2021-11-12 2:06 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-11 15:50 [PATCH v2] ptp: ptp_clockmatrix: repair non-kernel-doc comment Randy Dunlap
2021-11-12 2:06 ` Richard Cochran [this message]
2021-11-13 4:20 ` patchwork-bot+netdevbpf
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=20211112020603.GA464@hoboy.vegasvil.org \
--to=richardcochran@gmail.com \
--cc=davem@davemloft.net \
--cc=kuba@kernel.org \
--cc=lkp@intel.com \
--cc=min.li.xe@renesas.com \
--cc=netdev@vger.kernel.org \
--cc=rdunlap@infradead.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).