public inbox for netdev@vger.kernel.org
 help / color / mirror / Atom feed
From: Stephen Hemminger <stephen@networkplumber.org>
To: netdev@vger.kernel.org
Cc: Stephen Hemminger <stephen@networkplumber.org>
Subject: [PATCH iproute2-next 3/7] fix grammar and style issues in man pages for stat related pages
Date: Sat, 24 Jan 2026 11:49:27 -0800	[thread overview]
Message-ID: <20260124195824.221305-4-stephen@networkplumber.org> (raw)
In-Reply-To: <20260124195824.221305-1-stephen@networkplumber.org>

This patch addresses grammatical errors and style inconsistencies in
the ifstat, lnstat, and rtacct man pages documentation.

lnstat Changes:
  - Capitalize "Linux" as proper noun in NAME and DESCRIPTION sections
  - Add missing period to -j/--json option description
  - Fix passive voice: "is being used" -> "is used"
  - Fix word form: "can not" -> "cannot"

rtacct Changes:
  - Fix date format: remove comma in "27 June, 2007" -> "27 June 2007"
  - Remove period from NAME section per man page convention
  - Capitalize SNMP acronym (2 instances)
  - Add missing periods to -h and -V option descriptions
  - Improve clarity of -s/--noupdate description
  - Add missing article in -d/--scan description

No functional changes. All technical content remains accurate.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 man/man8/ifstat.8 |  4 ++--
 man/man8/lnstat.8 | 10 +++++-----
 man/man8/rtacct.8 | 16 ++++++++--------
 3 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/man/man8/ifstat.8 b/man/man8/ifstat.8
index 8cd164dd..35389d57 100644
--- a/man/man8/ifstat.8
+++ b/man/man8/ifstat.8
@@ -28,7 +28,7 @@ Show version of program.
 Ignore the history file.
 .TP
 .B \-d, \-\-scan=SECS
-Sample statistics every SECS second.
+Sample statistics every SECS seconds.
 .TP
 .B \-e, \-\-errors
 Show errors.
@@ -67,7 +67,7 @@ Show extended stats of TYPE. Supported types are:
 .SH ENVIRONMENT
 .TP
 .B IFSTAT_HISTORY
-If set, it's value is interpreted as alternate history file path.
+If set, its value is interpreted as alternate history file path.
 .SH SEE ALSO
 .BR ip (8)
 .br
diff --git a/man/man8/lnstat.8 b/man/man8/lnstat.8
index b98241bf..9b548f19 100644
--- a/man/man8/lnstat.8
+++ b/man/man8/lnstat.8
@@ -1,6 +1,6 @@
 .TH LNSTAT 8
 .SH NAME
-lnstat \- unified linux network statistics
+lnstat \- unified Linux network statistics
 .SH SYNOPSIS
 .B lnstat
 .RI [ options ]
@@ -13,7 +13,7 @@ command.
 rtstat program. It is commonly used to periodically print a selection of
 statistical values exported by the kernel.
 In addition to routing cache statistics, it supports any kind of statistics the
-linux kernel exports via a file in /proc/net/stat/.
+Linux kernel exports via a file in /proc/net/stat/.
 .PP
 Each file in /proc/net/stat/ contains a header line listing the column names.
 These names are used by \fBlnstat\fP as keys for selecting which statistics to
@@ -46,12 +46,12 @@ Statistics file to use, may be specified multiple times. By default all files in
 Set interval to 'intv' seconds.
 .TP
 .B \-j, \-\-json
-Display results in JSON format
+Display results in JSON format.
 .TP
 .B \-k, \-\-keys k,k,k,...
 Display only keys specified. Each key \fBk\fP is of the form \fB[file:]key\fP. If \fB<file>\fP
 is given, the search for the given key is limited to that file. Otherwise the first file containing
-the searched key is being used.
+the searched key is used.
 .TP
 .B \-s, \-\-subject [0-2]
 Specify display of subject/header. '0' means no header at all, '1' prints a header only at start of the program and '2' prints a header every 20 lines.
@@ -145,7 +145,7 @@ Number of \fBsearched\fP entries which were successful.
 Number of conntrack entries added which were not expected before.
 .sp
 .B invalid
-Number of packets seen which can not be tracked.
+Number of packets seen which cannot be tracked.
 .sp
 .B ignore
 Number of packets seen which are already connected to a conntrack entry.
diff --git a/man/man8/rtacct.8 b/man/man8/rtacct.8
index 988a6d1b..e3d9a1b7 100644
--- a/man/man8/rtacct.8
+++ b/man/man8/rtacct.8
@@ -1,7 +1,7 @@
-.TH RTACCT 8 "27 June, 2007"
+.TH RTACCT 8 "27 June 2007"
 
 .SH NAME
-nstat, rtacct - network statistics tools.
+nstat, rtacct - network statistics tools
 
 .SH SYNOPSIS
 Usage: nstat [ -h?vVzrnasd:t:jp ] [ PATTERN [ PATTERN ] ]
@@ -12,10 +12,10 @@ Usage: rtacct [ -h?vVzrnasd:t: ] [ ListOfRealms ]
 .B nstat
 and
 .B rtacct
-are simple tools to monitor kernel snmp counters and network interface statistics.
+are simple tools to monitor kernel SNMP counters and network interface statistics.
 
 .B nstat
-can filter kernel snmp counters by name with one or several specified wildcards. Wildcards are case-insensitive and can include special symbols
+can filter kernel SNMP counters by name with one or several specified wildcards. Wildcards are case-insensitive and can include special symbols
 .B ?
 and
 .B *
@@ -23,10 +23,10 @@ and
 
 .SH OPTIONS
 .B \-h, \-\-help
-Print help
+Print help.
 .TP
 .B \-V, \-\-version
-Print version
+Print version.
 .TP
 .B \-z, \-\-zeros
 Dump zero counters too. By default they are not shown.
@@ -41,7 +41,7 @@ Do not display anything, only update history.
 Dump absolute values of counters. The default is to calculate increments since the previous use.
 .TP
 .B \-s, \-\-noupdate
-Do not update history, so that the next time you will see counters including values accumulated to the moment of this measurement too.
+Do not update history, so that the next time you will see counters including values accumulated up to this measurement.
 .TP
 .B \-j, \-\-json
 Display results in JSON format.
@@ -52,7 +52,7 @@ When combined with
 pretty print the output.
 .TP
 .B \-d, \-\-scan <INTERVAL>
-Run in daemon mode collecting statistics. <INTERVAL> is interval between measurements in seconds.
+Run in daemon mode collecting statistics. <INTERVAL> is the interval between measurements in seconds.
 .TP
 .B \-t, \-\-interval <INTERVAL>
 Time interval to average rates. Default value is 60 seconds.
-- 
2.51.0


  parent reply	other threads:[~2026-01-24 19:58 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-24 19:49 [PATCH iproute2-next 0/7] man page corrections Stephen Hemminger
2026-01-24 19:49 ` [PATCH iproute2-next 1/7] dcb: fix grammar and style issues in man pages Stephen Hemminger
2026-01-24 19:49 ` [PATCH iproute2-next 2/7] devlink: " Stephen Hemminger
2026-01-24 19:49 ` Stephen Hemminger [this message]
2026-01-24 19:49 ` [PATCH iproute2-next 4/7] netshaper: fix grammar and style issues in man page Stephen Hemminger
2026-01-24 19:49 ` [PATCH iproute2-next 5/7] tipc: fix grammar and style issues in man pages Stephen Hemminger
2026-01-24 19:49 ` [PATCH iproute2-next 6/7] vdpa: fix grammar, titles, and formatting " Stephen Hemminger
2026-01-24 19:49 ` [PATCH iproute2-next 7/7] rdma: fix grammar, formatting, and style " Stephen Hemminger
2026-01-31 19:20 ` [PATCH iproute2-next 0/7] man page corrections 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=20260124195824.221305-4-stephen@networkplumber.org \
    --to=stephen@networkplumber.org \
    --cc=netdev@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