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 0/7] man page corrections
Date: Sat, 24 Jan 2026 11:49:24 -0800	[thread overview]
Message-ID: <20260124195824.221305-1-stephen@networkplumber.org> (raw)

AI does a great job of finding and fixing manual pages.
This patch series is the result of editorial review and correction of
subsystem man pages, addressing grammatical errors, style inconsistencies, and
clarity issues throughout the documentation.

The corrections cover the following subsystems:
  - DCB (Data Center Bridging)
  - devlink
  - Statistics tools (lnstat, rtacct, nstat)
  - netshaper
  - TIPC
  - vdpa
  - RDMA

Common patterns corrected across all man pages:
  - Subject-verb agreement and singular/plural consistency
  - Missing or incorrect articles (a, an, the)
  - Inconsistent verb tenses in command descriptions
  - Missing terminal punctuation in examples and descriptions
  - Overly long section headers (split into concise headers + body text)
  - Awkward or non-idiomatic English phrasing
  - Copy-paste errors (e.g., incorrect titles from template files)
  - Formatting issues (duplicate markup, missing commas in cross-references)

All corrections are purely editorial. No functional changes have been made, and
all technical content remains accurate. The documentation now maintains consistent
style and proper grammar while preserving the original technical information.

Total corrections: approximately 100+ individual fixes across 40+ man page files.

Stephen Hemminger (7):
  dcb: fix grammar and style issues in man pages
  devlink: fix grammar and style issues in man pages
  fix grammar and style issues in man pages for stat tools
  netshaper: fix grammar and style issues in man page
  tipc: fix grammar and style issues in man pages
  vdpa: fix grammar, titles, and formatting in man pages
  rdma: fix grammar, formatting, and style in man pages

 man/man8/dcb-app.8          |  24 +++---
 man/man8/dcb-apptrust.8     |  16 ++--
 man/man8/dcb-buffer.8       |   4 +-
 man/man8/dcb-dcbx.8         |   2 +-
 man/man8/dcb-ets.8          |   4 +-
 man/man8/dcb-rewr.8         |  34 ++++----
 man/man8/dcb.8              |   7 +-
 man/man8/devlink-dev.8      |  38 ++++-----
 man/man8/devlink-port.8     |  42 +++++-----
 man/man8/devlink-rate.8     |  28 +++----
 man/man8/devlink.8          |  12 +--
 man/man8/lnstat.8           |  10 +--
 man/man8/netshaper.8        |  14 ++--
 man/man8/rdma-dev.8         |  28 +++----
 man/man8/rdma-link.8        |  12 +--
 man/man8/rdma-monitor.8     |   8 +-
 man/man8/rdma-resource.8    |  14 ++--
 man/man8/rdma-statistic.8   |  36 ++++----
 man/man8/rdma-system.8      |   6 +-
 man/man8/rdma.8             |  12 +--
 man/man8/rtacct.8           |  18 ++--
 man/man8/tipc-bearer.8      |  10 +--
 man/man8/tipc-link.8        |  16 ++--
 man/man8/tipc-nametable.8   |  18 ++--
 man/man8/tipc-node.8        |   6 +-
 man/man8/tipc-socket.8      |   4 +-
 man/man8/tipc.8             |   4 +-
 man/man8/vdpa-dev.8         |  24 +++---
 man/man8/vdpa-mgmtdev.8     |   6 +-
 man/man8/vdpa.8             |   4 +-
 30 files changed, 231 insertions(+), 230 deletions(-)

-- 
2.43.0

Stephen Hemminger (7):
  dcb: fix grammar and style issues in man pages
  devlink: fix grammar and style issues in man pages
  fix grammar and style issues in man pages for stat related pages
  netshaper: fix grammar and style issues in man page
  tipc: fix grammar and style issues in man pages
  vdpa: fix grammar, titles, and formatting in man pages
  rdma: fix grammar, formatting, and style in man pages

 man/man8/dcb-app.8        | 24 ++++++++++++------------
 man/man8/dcb-apptrust.8   | 16 ++++++++--------
 man/man8/dcb-buffer.8     |  4 ++--
 man/man8/dcb-dcbx.8       |  2 +-
 man/man8/dcb-ets.8        |  4 ++--
 man/man8/dcb-rewr.8       | 34 +++++++++++++++++-----------------
 man/man8/dcb.8            |  7 ++++---
 man/man8/devlink-dev.8    |  8 ++++----
 man/man8/devlink-port.8   | 18 +++++++++---------
 man/man8/devlink-rate.8   | 18 +++++++++---------
 man/man8/devlink.8        | 25 ++++++++++++++++++++-----
 man/man8/ifstat.8         |  4 ++--
 man/man8/lnstat.8         | 10 +++++-----
 man/man8/netshaper.8      | 19 ++++++++++---------
 man/man8/rdma-dev.8       | 23 ++++++++++++++---------
 man/man8/rdma-link.8      | 10 ++++++----
 man/man8/rdma-monitor.8   |  7 +++++--
 man/man8/rdma-resource.8  |  6 +++---
 man/man8/rdma-statistic.8 | 24 +++++++++++++-----------
 man/man8/rdma-system.8    |  3 +--
 man/man8/rdma.8           |  8 ++++----
 man/man8/rtacct.8         | 16 ++++++++--------
 man/man8/tipc-bearer.8    |  6 +++---
 man/man8/tipc-link.8      | 10 +++++-----
 man/man8/tipc-nametable.8 | 11 +++++------
 man/man8/tipc-node.8      |  4 ++--
 man/man8/tipc-socket.8    |  2 +-
 man/man8/tipc.8           |  2 +-
 man/man8/vdpa-dev.8       | 18 ++++++++++--------
 man/man8/vdpa-mgmtdev.8   |  4 ++--
 man/man8/vdpa.8           |  2 +-
 31 files changed, 189 insertions(+), 160 deletions(-)

-- 
2.51.0


             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 Stephen Hemminger [this message]
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 ` [PATCH iproute2-next 3/7] fix grammar and style issues in man pages for stat related pages Stephen Hemminger
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-1-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