[PATCH 00/29] doc/guides: sample application documentation improvements

[Stephen Hemminger <stephen@networkplumber.org>]

This series addresses grammar, clarity, consistency, and structural
issues across DPDK sample application documentation guides.
Initial work was done by tech writer Nandini but never merged;
picked those up and added AI grammar and style review fixes.
Looks much better and consistent now.

The changes include:

Capitalization fixes:
  - "linux" to "Linux" per DPDK style guidelines
  - "Qemu" to "QEMU"
  - Consistent use of VMDq, vDPA, DCB terminology

Grammar and clarity:
  - Adding missing articles ("a", "the", "an")
  - Fixing incomplete sentences
  - Correcting subject-verb agreement
  - Fixing typos (e.g., "Keep- Alive" to "Keep-Alive")

Formatting consistency:
  - Adding proper RST code formatting with double backticks
  - Standardizing section headers with "Overview" sections
  - Using consistent command-line option formatting

Style improvements:
  - Replacing contractions with full forms
  - Adding Oxford commas where appropriate
  - Removing outdated trademark symbols

Content fixes:
  - Fixed duplicate "srTCM" entries to show correct "trTCM" options
    in QoS metering documentation
  - Completed truncated phrase "and also on the main" to
    "and also on the main lcore" in timer documentation

The following sample application guides are updated:
  - timer
  - packet_ordering
  - service_cores
  - rxtx_callbacks
  - skeleton
  - l2_forward_crypto
  - l2_forward_event
  - qos_metering
  - qos_scheduler
  - vmdq_forwarding
  - vmdq_dcb_forwarding
  - vhost
  - vhost_blk
  - vhost_crypto
  - ptpclient
  - vdpa
  - cmd_line
  - dma
  - fips_validation
  - hello_world
  - intro
  - ip_pipeline
  - ipsec_secgw
  - l3_forward
  - multi_process
  - vm_power_management
  - keep_alive

Stephen Hemminger (29):
  examples/timer: correct documentation errors
  examples/packet_ordering: correct documentation errors
  examples/service_cores: correct documentation errors
  examples/rxtx_callbacks: correct documentation errors
  examples/ip_fragmentation: correct documentation errors
  examples/eventdev_pipeline: correct documentation errors
  doc/guides: improve VMDq sample application documentation
  examples/distributor: correct documentation errors
  examples/ipv4_multicast: correct documentation typo
  examples/test_pipeline: correct documentation errors
  examples/qos: improve sample application documentation
  examples/vhost: improve sample application documentation
  examples/ptpclient: improve sample application documentation
  doc/guides: improve vDPA sample application guide
  doc/guides: improve command line sample app guide
  doc/guides: improve DMA sample app guide
  doc/guides: improve FIPS validation sample app guide
  doc/guides: improve Hello World sample app guide
  doc/guides: improve sample applications introduction
  doc/guides: improve IP pipeline sample app guide
  doc/guides: improve IP reassembly sample app guide
  doc/guides: improve IPsec security gateway guide
  doc/guides: improve link status interrupt sample app guide
  doc/guides: improve multi-process sample app guide
  doc/guides: improve pipeline sample app guide
  doc/guides: improve VM power management sample app guide
  doc/guides: improve keep alive sample app guide
  fix ipsec gw
  fix pipeline

 doc/guides/sample_app_ug/cmd_line.rst         |  20 +-
 doc/guides/sample_app_ug/dist_app.rst         |  30 +--
 doc/guides/sample_app_ug/dma.rst              | 104 ++++-----
 .../sample_app_ug/eventdev_pipeline.rst       |  22 +-
 doc/guides/sample_app_ug/fips_validation.rst  | 117 +++++-----
 doc/guides/sample_app_ug/hello_world.rst      |  10 +-
 doc/guides/sample_app_ug/intro.rst            |  54 ++---
 doc/guides/sample_app_ug/ip_frag.rst          |   4 +-
 doc/guides/sample_app_ug/ip_pipeline.rst      |  18 +-
 doc/guides/sample_app_ug/ip_reassembly.rst    |  12 +-
 doc/guides/sample_app_ug/ipsec_secgw.rst      |  92 ++++----
 doc/guides/sample_app_ug/ipv4_multicast.rst   |   2 +-
 doc/guides/sample_app_ug/keep_alive.rst       |   8 +-
 doc/guides/sample_app_ug/link_status_intr.rst |   6 +-
 doc/guides/sample_app_ug/multi_process.rst    |  27 +--
 doc/guides/sample_app_ug/packet_ordering.rst  |  23 +-
 doc/guides/sample_app_ug/pipeline.rst         |  10 +-
 doc/guides/sample_app_ug/ptpclient.rst        | 139 ++++++------
 doc/guides/sample_app_ug/qos_metering.rst     |  95 ++++----
 doc/guides/sample_app_ug/qos_scheduler.rst    | 214 +++++++++---------
 doc/guides/sample_app_ug/rxtx_callbacks.rst   |   7 +-
 doc/guides/sample_app_ug/service_cores.rst    |  41 ++--
 doc/guides/sample_app_ug/test_pipeline.rst    |   2 +-
 doc/guides/sample_app_ug/timer.rst            |  45 ++--
 doc/guides/sample_app_ug/vdpa.rst             |  71 +++---
 doc/guides/sample_app_ug/vhost.rst            | 185 +++++++--------
 doc/guides/sample_app_ug/vhost_blk.rst        |  58 ++---
 doc/guides/sample_app_ug/vhost_crypto.rst     |  94 ++++----
 .../sample_app_ug/vm_power_management.rst     | 138 ++++++-----
 .../sample_app_ug/vmdq_dcb_forwarding.rst     | 193 ++++++++++------
 doc/guides/sample_app_ug/vmdq_forwarding.rst  | 144 +++++++-----
 31 files changed, 1050 insertions(+), 935 deletions(-)

-- 
2.51.0