diff mbox series

[iwl-next,v1,1/5] net: docs: add missing features that can have stats

Message ID 20240604221327.299184-2-jesse.brandeburg@intel.com (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series ice: add standard stats | expand

Checks

Context Check Description
netdev/series_format warning Target tree name not specified in the subject
netdev/tree_selection success Guessed tree name to be net-next
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 8 this patch: 8
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers warning 3 maintainers not CCed: pabeni@redhat.com kuba@kernel.org edumazet@google.com
netdev/build_clang success Errors and warnings before: 8 this patch: 8
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 8 this patch: 8
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 12 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Jesse Brandeburg June 4, 2024, 10:13 p.m. UTC
While trying to figure out ethtool -I | --include-statistics, I noticed
some docs got missed when implementing commit 0e9c127729be ("ethtool:
add interface to read Tx hardware timestamping statistics").

Fix up the docs to match the kernel code, and while there, sort them in
alphabetical order.

Cc: Rahul Rameshbabu <rrameshbabu@nvidia.com>
Reviewed-by: Jacob Keller <jacob.e.keller@intel.com>
Signed-off-by: Jesse Brandeburg <jesse.brandeburg@intel.com>
---
I didn't add a Fixes: tag because this is not an urgent kind of fix that
should require backports.
---
 Documentation/networking/statistics.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Rahul Rameshbabu June 4, 2024, 10:19 p.m. UTC | #1
On Tue, 04 Jun, 2024 15:13:21 -0700 Jesse Brandeburg <jesse.brandeburg@intel.com> wrote:
> While trying to figure out ethtool -I | --include-statistics, I noticed
> some docs got missed when implementing commit 0e9c127729be ("ethtool:
> add interface to read Tx hardware timestamping statistics").
>
> Fix up the docs to match the kernel code, and while there, sort them in
> alphabetical order.
>
> Cc: Rahul Rameshbabu <rrameshbabu@nvidia.com>
> Reviewed-by: Jacob Keller <jacob.e.keller@intel.com>
> Signed-off-by: Jesse Brandeburg <jesse.brandeburg@intel.com>
> ---
> I didn't add a Fixes: tag because this is not an urgent kind of fix that
> should require backports.
> ---
>  Documentation/networking/statistics.rst | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/networking/statistics.rst b/Documentation/networking/statistics.rst
> index 75e017dfa825..22503a90e369 100644
> --- a/Documentation/networking/statistics.rst
> +++ b/Documentation/networking/statistics.rst
> @@ -184,9 +184,11 @@ Protocol-related statistics can be requested in get commands by setting
>  the `ETHTOOL_FLAG_STATS` flag in `ETHTOOL_A_HEADER_FLAGS`. Currently
>  statistics are supported in the following commands:
>  
> -  - `ETHTOOL_MSG_PAUSE_GET`
>    - `ETHTOOL_MSG_FEC_GET`
> +  - 'ETHTOOL_MSG_LINKSTATE_GET'
>    - `ETHTOOL_MSG_MM_GET`
> +  - `ETHTOOL_MSG_PAUSE_GET`
> +  - 'ETHTOOL_MSG_TSINFO_GET'
>  
>  debugfs
>  -------

Thanks for catching this.

Reviewed-by: Rahul Rameshbabu <rrameshbabu@nvidia.com>
Jakub Kicinski June 6, 2024, 12:48 a.m. UTC | #2
On Tue,  4 Jun 2024 15:13:21 -0700 Jesse Brandeburg wrote:
> -  - `ETHTOOL_MSG_PAUSE_GET`
>    - `ETHTOOL_MSG_FEC_GET`
> +  - 'ETHTOOL_MSG_LINKSTATE_GET'
>    - `ETHTOOL_MSG_MM_GET`
> +  - `ETHTOOL_MSG_PAUSE_GET`
> +  - 'ETHTOOL_MSG_TSINFO_GET'

I was going to steal this directly but:
` vs '
so I'll let it go via the Intel tree :)
Jesse Brandeburg June 6, 2024, 4:28 p.m. UTC | #3
On 6/5/2024 5:48 PM, Jakub Kicinski wrote:
> On Tue,  4 Jun 2024 15:13:21 -0700 Jesse Brandeburg wrote:
>> -  - `ETHTOOL_MSG_PAUSE_GET`
>>    - `ETHTOOL_MSG_FEC_GET`
>> +  - 'ETHTOOL_MSG_LINKSTATE_GET'
>>    - `ETHTOOL_MSG_MM_GET`
>> +  - `ETHTOOL_MSG_PAUSE_GET`
>> +  - 'ETHTOOL_MSG_TSINFO_GET'
> 
> I was going to steal this directly but:
> ` vs '
> so I'll let it go via the Intel tree :)
> 

Thank you Jakub, I had to stare really deeply at that comment to
understand "backtick vs single-quote" as for the longest time I couldn't
understand why you were quoting the word "vs" - sheesh :-)

I didn't even know/remember the docs required backticks vs some other
quote looking thing, it never even occurred to me, so thanks for calling
that out.

I'll send a v2 with the fix so Jake can pick it up while Tony is out.

-Jesse
Jacob Keller June 6, 2024, 4:56 p.m. UTC | #4
On 6/5/2024 5:48 PM, Jakub Kicinski wrote:
> On Tue,  4 Jun 2024 15:13:21 -0700 Jesse Brandeburg wrote:
>> -  - `ETHTOOL_MSG_PAUSE_GET`
>>    - `ETHTOOL_MSG_FEC_GET`
>> +  - 'ETHTOOL_MSG_LINKSTATE_GET'
>>    - `ETHTOOL_MSG_MM_GET`
>> +  - `ETHTOOL_MSG_PAUSE_GET`
>> +  - 'ETHTOOL_MSG_TSINFO_GET'
> 
> I was going to steal this directly but:
> ` vs '
> so I'll let it go via the Intel tree :)

Yea, this needs to be consistently ` here for rST formatting to match.
diff mbox series

Patch

diff --git a/Documentation/networking/statistics.rst b/Documentation/networking/statistics.rst
index 75e017dfa825..22503a90e369 100644
--- a/Documentation/networking/statistics.rst
+++ b/Documentation/networking/statistics.rst
@@ -184,9 +184,11 @@  Protocol-related statistics can be requested in get commands by setting
 the `ETHTOOL_FLAG_STATS` flag in `ETHTOOL_A_HEADER_FLAGS`. Currently
 statistics are supported in the following commands:
 
-  - `ETHTOOL_MSG_PAUSE_GET`
   - `ETHTOOL_MSG_FEC_GET`
+  - 'ETHTOOL_MSG_LINKSTATE_GET'
   - `ETHTOOL_MSG_MM_GET`
+  - `ETHTOOL_MSG_PAUSE_GET`
+  - 'ETHTOOL_MSG_TSINFO_GET'
 
 debugfs
 -------