This series revises the sample application user guides for clarity, grammar, and formatting consistency. Changes are documentation only: wording is simplified, command-line options are normalised, Linux and Ethernet capitalisation is corrected, and definition lists replace ad hoc bullet lists where a term/description structure fits.
This work started from edits by Nandini Persad and was extended and reworked across the rest of the sample application guides. Stephen Hemminger (15): doc: cleanups to bbdev sample application doc: cleanup cmd_line example documentation doc: cleanup the distribution sample application guide doc: improve structure and clarity of compiling guide doc: improve clarity and consistency in DMA sample app guide doc: correct capitalization and formatting in ethtool guide doc: improve clarity in eventdev, FIPS, and flow filtering doc: enhance hello_world, intro, IP frag and pipeline doc: improve IP reassembly, IPsec, multicast, and keep-alive doc: enhance L2 forwarding sample application guides doc: enhance multi-process, NTB, ordering, and PTP guides doc: improve QoS, callbacks, EFD, and service cores guides doc: enhance skeleton, pipeline, timer, and vhost guides doc: improve vhost, VM power, and VMDq sample guides doc: correct grammar and punctuation consistency issues doc/guides/sample_app_ug/bbdev_app.rst | 73 +++-- doc/guides/sample_app_ug/cmd_line.rst | 37 +-- doc/guides/sample_app_ug/compiling.rst | 84 +++--- doc/guides/sample_app_ug/dist_app.rst | 52 ++-- doc/guides/sample_app_ug/dma.rst | 60 ++-- doc/guides/sample_app_ug/ethtool.rst | 18 +- .../sample_app_ug/eventdev_pipeline.rst | 51 ++-- doc/guides/sample_app_ug/fips_validation.rst | 65 +++-- doc/guides/sample_app_ug/flow_filtering.rst | 51 ++-- doc/guides/sample_app_ug/hello_world.rst | 8 +- doc/guides/sample_app_ug/intro.rst | 34 +-- doc/guides/sample_app_ug/ip_frag.rst | 46 +-- doc/guides/sample_app_ug/ip_pipeline.rst | 109 ++++---- doc/guides/sample_app_ug/ip_reassembly.rst | 57 ++-- doc/guides/sample_app_ug/ipsec_secgw.rst | 128 ++++----- doc/guides/sample_app_ug/ipv4_multicast.rst | 26 +- doc/guides/sample_app_ug/keep_alive.rst | 12 +- doc/guides/sample_app_ug/l2_forward_cat.rst | 34 +-- .../sample_app_ug/l2_forward_crypto.rst | 70 +++-- doc/guides/sample_app_ug/l2_forward_event.rst | 20 +- .../sample_app_ug/l2_forward_job_stats.rst | 46 ++- .../sample_app_ug/l2_forward_macsec.rst | 38 +-- .../sample_app_ug/l2_forward_real_virtual.rst | 4 +- doc/guides/sample_app_ug/link_status_intr.rst | 2 +- doc/guides/sample_app_ug/multi_process.rst | 49 ++-- doc/guides/sample_app_ug/ntb.rst | 4 +- doc/guides/sample_app_ug/packet_ordering.rst | 42 +-- doc/guides/sample_app_ug/pipeline.rst | 26 +- doc/guides/sample_app_ug/ptp_tap_relay_sw.rst | 2 +- doc/guides/sample_app_ug/ptpclient.rst | 51 ++-- doc/guides/sample_app_ug/qos_metering.rst | 11 +- doc/guides/sample_app_ug/qos_scheduler.rst | 16 +- doc/guides/sample_app_ug/rxtx_callbacks.rst | 11 +- doc/guides/sample_app_ug/server_node_efd.rst | 4 +- doc/guides/sample_app_ug/service_cores.rst | 67 ++--- doc/guides/sample_app_ug/skeleton.rst | 8 +- doc/guides/sample_app_ug/test_pipeline.rst | 17 +- doc/guides/sample_app_ug/timer.rst | 19 +- doc/guides/sample_app_ug/vdpa.rst | 51 ++-- doc/guides/sample_app_ug/vhost.rst | 178 ++++++------ doc/guides/sample_app_ug/vhost_blk.rst | 66 +++-- doc/guides/sample_app_ug/vhost_crypto.rst | 64 ++--- .../sample_app_ug/vm_power_management.rst | 262 ++++++++---------- .../sample_app_ug/vmdq_dcb_forwarding.rst | 101 ++++--- doc/guides/sample_app_ug/vmdq_forwarding.rst | 38 ++- 45 files changed, 1121 insertions(+), 1091 deletions(-) -- 2.53.0
