From: Rahul Rameshbabu <rrameshbabu@nvidia•com>
To: Jakub Kicinski <kuba@kernel•org>
Cc: netdev@vger•kernel.org, linux-kernel@vger•kernel.org,
linux-doc@vger•kernel.org, ahmed.zaki@intel•com,
aleksander.lobakin@intel•com, alexandre.torgue@foss•st.com,
andrew@lunn•ch, cjubran@nvidia•com, corbet@lwn•net,
davem@davemloft•net, dtatulea@nvidia•com, edumazet@google•com,
gal@nvidia•com, hkallweit1@gmail•com, jacob.e.keller@intel•com,
jiri@resnulli•us, joabreu@synopsys•com, justinstitt@google•com,
kory.maincent@bootlin•com, leon@kernel•org, liuhangbin@gmail•com,
maxime.chevallier@bootlin•com, pabeni@redhat•com,
paul.greenwalt@intel•com, przemyslaw.kitszel@intel•com,
rdunlap@infradead•org, richardcochran@gmail•com,
saeed@kernel•org, tariqt@nvidia•com, vadim.fedorenko@linux•dev,
vladimir.oltean@nxp•com, wojciech.drewek@intel•com
Subject: Re: [PATCH net-next v1 1/6] ethtool: add interface to read Tx hardware timestamping statistics
Date: Tue, 02 Apr 2024 22:14:38 -0700 [thread overview]
Message-ID: <87r0fn2e2b.fsf@nvidia.com> (raw)
In-Reply-To: <20240402191842.66decfd3@kernel.org>
On Tue, 02 Apr, 2024 19:18:42 -0700 Jakub Kicinski <kuba@kernel•org> wrote:
> On Tue, 2 Apr 2024 13:52:01 -0700 Rahul Rameshbabu wrote:
>> +/**
>> + * struct ethtool_ts_stats - HW timestamping statistics
>> + * @tx_stats: struct group for TX HW timestamping
>> + * @pkts: Number of packets successfully timestamped by the hardware.
>> + * @lost: Number of hardware timestamping requests where the timestamping
>> + * information from the hardware never arrived for submission with
>> + * the skb.
>> + * @err: Number of arbitrary timestamp generation error events that the
>> + * hardware encountered, exclusive of @lost statistics. Cases such
>> + * as resource exhaustion, unavailability, firmware errors, and
>> + * detected illogical timestamp values not submitted with the skb
>> + * are inclusive to this counter.
>> + */
>> +struct ethtool_ts_stats {
>> + struct_group(tx_stats,
>
> Doesn't seem like the group should be documented:
>
> include/linux/ethtool.h:503: warning: Excess struct member 'tx_stats' description in 'ethtool_ts_stats'
Was looking into why our internal verification did not catch this. We
run W=1 with clang, but looks like the warning does not get triggered
unless explicitly run with scripts/kernel-doc.
https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#how-to-format-kernel-doc-comments
I have debugged using strace that the way the kernel doc checking works
when W=1 is set is that the matching source file that is being compiled
is passed to scripts/kernel-doc, so include files are missed from the
doc check. I think this is worth adding to the kernel documentation.
Anyway, I will send out a v2 with this fixed but wait for potentially
more feedback on v1.
--
Thanks,
Rahul Rameshbabu
next prev parent reply other threads:[~2024-04-03 5:46 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-02 20:52 [PATCH net-next v1 0/6] ethtool HW timestamping statistics Rahul Rameshbabu
2024-04-02 20:52 ` [PATCH net-next v1 1/6] ethtool: add interface to read Tx hardware " Rahul Rameshbabu
2024-04-03 2:18 ` Jakub Kicinski
2024-04-03 5:14 ` Rahul Rameshbabu [this message]
2024-04-03 18:44 ` Keller, Jacob E
2024-04-03 20:56 ` Rahul Rameshbabu
2024-04-02 20:52 ` [PATCH net-next v1 2/6] net/mlx5e: Introduce lost_cqe statistic counter for PTP Tx port timestamping CQ Rahul Rameshbabu
2024-04-02 20:52 ` [PATCH net-next v1 3/6] net/mlx5e: Introduce timestamps statistic counter for Tx DMA layer Rahul Rameshbabu
2024-04-02 20:52 ` [PATCH net-next v1 4/6] net/mlx5e: Implement ethtool hardware timestamping statistics Rahul Rameshbabu
2024-04-02 20:52 ` [PATCH net-next v1 5/6] netlink: specs: ethtool: add header-flags enumeration Rahul Rameshbabu
2024-04-02 20:52 ` [PATCH net-next v1 6/6] tools: ynl: ethtool.py: Output timestamping statistics from tsinfo-get operation Rahul Rameshbabu
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=87r0fn2e2b.fsf@nvidia.com \
--to=rrameshbabu@nvidia$(echo .)com \
--cc=ahmed.zaki@intel$(echo .)com \
--cc=aleksander.lobakin@intel$(echo .)com \
--cc=alexandre.torgue@foss$(echo .)st.com \
--cc=andrew@lunn$(echo .)ch \
--cc=cjubran@nvidia$(echo .)com \
--cc=corbet@lwn$(echo .)net \
--cc=davem@davemloft$(echo .)net \
--cc=dtatulea@nvidia$(echo .)com \
--cc=edumazet@google$(echo .)com \
--cc=gal@nvidia$(echo .)com \
--cc=hkallweit1@gmail$(echo .)com \
--cc=jacob.e.keller@intel$(echo .)com \
--cc=jiri@resnulli$(echo .)us \
--cc=joabreu@synopsys$(echo .)com \
--cc=justinstitt@google$(echo .)com \
--cc=kory.maincent@bootlin$(echo .)com \
--cc=kuba@kernel$(echo .)org \
--cc=leon@kernel$(echo .)org \
--cc=linux-doc@vger$(echo .)kernel.org \
--cc=linux-kernel@vger$(echo .)kernel.org \
--cc=liuhangbin@gmail$(echo .)com \
--cc=maxime.chevallier@bootlin$(echo .)com \
--cc=netdev@vger$(echo .)kernel.org \
--cc=pabeni@redhat$(echo .)com \
--cc=paul.greenwalt@intel$(echo .)com \
--cc=przemyslaw.kitszel@intel$(echo .)com \
--cc=rdunlap@infradead$(echo .)org \
--cc=richardcochran@gmail$(echo .)com \
--cc=saeed@kernel$(echo .)org \
--cc=tariqt@nvidia$(echo .)com \
--cc=vadim.fedorenko@linux$(echo .)dev \
--cc=vladimir.oltean@nxp$(echo .)com \
--cc=wojciech.drewek@intel$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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