From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>,
Cristian Dumitrescu <cristian.dumitrescu@intel.com>
Subject: [PATCH v2 8/8] doc: correct grammar and improve clarity in MTR guide
Date: Wed, 28 Jan 2026 11:46:07 -0800 [thread overview]
Message-ID: <20260128194722.480862-9-stephen@networkplumber.org> (raw)
In-Reply-To: <20260128194722.480862-1-stephen@networkplumber.org>
Correct grammatical issues and improve clarity in the traffic metering
and policing documentation:
- Correct grammar: "override the color the packet" to "override the
color of the packet"
- Correct typo: "show" to "shown" for correct past participle
- Standardize terminology: use "color-aware" and "color-blind"
consistently with hyphens as compound adjectives
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
.../prog_guide/ethdev/traffic_metering_and_policing.rst | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/doc/guides/prog_guide/ethdev/traffic_metering_and_policing.rst b/doc/guides/prog_guide/ethdev/traffic_metering_and_policing.rst
index 7f9faf36e2..de8d643fb1 100644
--- a/doc/guides/prog_guide/ethdev/traffic_metering_and_policing.rst
+++ b/doc/guides/prog_guide/ethdev/traffic_metering_and_policing.rst
@@ -47,15 +47,17 @@ Traffic metering determines the color for the current packet (green, yellow,
red) based on the previous history for this flow as maintained by the MTR
object. The policer can do nothing, override the color the packet or drop the
packet. Statistics counters are maintained for MTR object, as configured.
+object. The policer can do nothing, override the color of the packet, or drop the
+packet. Statistics counters are maintained for each MTR object, as configured.
The processing done for each input packet hitting an MTR object is:
* Traffic metering: The packet is assigned a color (the meter output color)
based on the previous traffic history reflected in the current state of the
MTR object, according to the specific traffic metering algorithm. The
- traffic metering algorithm can typically work in color aware mode, in which
+ traffic metering algorithm can typically work in color-aware mode, in which
case the input packet already has an initial color (the input color), or in
- color blind mode, which is equivalent to considering all input packets
+ color-blind mode, which is equivalent to considering all input packets
initially colored as green.
* There is a meter policy API to manage pre-defined policies for meter.
@@ -105,7 +107,7 @@ traffic meter and policing library.
* Adding one (or multiple) actions of the type ``RTE_FLOW_ACTION_TYPE_METER``
to the list of meter actions (``struct rte_mtr_meter_policy_params::actions``)
- specified per color as show in :numref:`figure_rte_mtr_chaining`.
+ specified per color as shown in :numref:`figure_rte_mtr_chaining`.
#. The ``rte_mtr_meter_profile_get()`` and ``rte_mtr_meter_policy_get()``
API functions are available for getting the object pointers directly.
--
2.51.0
next prev parent reply other threads:[~2026-01-28 19:48 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-16 21:29 [PATCH 0/5] doc: ethdev documentation grammar and typo corrections Stephen Hemminger
2026-01-16 21:29 ` [PATCH 1/5] doc: correct grammar and punctuation errors in ethdev guide Stephen Hemminger
2026-01-16 21:29 ` [PATCH 2/5] doc: correct grammar in rte_flow guide Stephen Hemminger
2026-01-16 21:29 ` [PATCH 3/5] doc: correct grammar in QoS framework guide Stephen Hemminger
2026-01-16 21:29 ` [PATCH 4/5] doc: correct typos in switch representation guide Stephen Hemminger
2026-01-16 21:29 ` [PATCH 5/5] doc: correct typos in traffic management guide Stephen Hemminger
2026-01-28 19:45 ` [PATCH v2 0/8] doc: ethdev documentation grammar and typo corrections Stephen Hemminger
2026-01-28 19:46 ` [PATCH v2 1/8] doc: correct grammar and punctuation errors in ethdev guide Stephen Hemminger
2026-01-28 19:46 ` [PATCH v2 2/8] doc: correct grammar in flow guide Stephen Hemminger
2026-01-28 19:46 ` [PATCH v2 3/8] doc: correct grammar in QoS framework guide Stephen Hemminger
2026-01-28 19:46 ` [PATCH v2 4/8] doc: correct typos in switch representation guide Stephen Hemminger
2026-01-28 19:46 ` [PATCH v2 5/8] doc: correct typos in traffic management guide Stephen Hemminger
2026-01-28 19:46 ` [PATCH v2 6/8] doc: correct grammar and improve clarity in ethdev guide Stephen Hemminger
2026-03-25 11:41 ` Thomas Monjalon
2026-01-28 19:46 ` [PATCH v2 7/8] doc: correct alphabetical ordering in ethdev toctree Stephen Hemminger
2026-03-25 11:45 ` Thomas Monjalon
2026-01-28 19:46 ` Stephen Hemminger [this message]
2026-02-05 21:29 ` [PATCH v2 0/8] doc: ethdev documentation grammar and typo corrections Stephen Hemminger
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=20260128194722.480862-9-stephen@networkplumber.org \
--to=stephen@networkplumber.org \
--cc=cristian.dumitrescu@intel.com \
--cc=dev@dpdk.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