|WARNING| pw151551 [PATCH v2] doc: reword sample application guides

|WARNING| pw151551 [PATCH v2] doc: reword sample application guides

[qemudev]

Test-Label: loongarch-compilation
Test-Status: WARNING
http://dpdk.org/patch/151551

_apply patch failure_

Submitter: Nandini Persad <nandinipersad361@gmail.com>
Date: Sun, 16 Feb 2025 15:09:03 -0800
DPDK git baseline: Repo:dpdk
  Branch: main
  CommitID: e5176f23ae8b31437c3e5eb875c81f95bf3a9942

Apply patch set 151551 failed:

Checking patch doc/guides/sample_app_ug/dist_app.rst...
Checking patch doc/guides/sample_app_ug/eventdev_pipeline.rst...
Checking patch doc/guides/sample_app_ug/fips_validation.rst...
Checking patch doc/guides/sample_app_ug/ip_pipeline.rst...
Checking patch doc/guides/sample_app_ug/ipsec_secgw.rst...
Hunk #8 succeeded at 1138 (offset 1 line).
Hunk #9 succeeded at 1171 (offset 1 line).
Checking patch doc/guides/sample_app_ug/multi_process.rst...
error: while searching for:

This chapter describes the example applications for multi-processing that are included in the DPDK.

Example Applications
--------------------

Building the Sample Applications
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The multi-process example applications are built in the same way as other sample applications,
and as documented in the *DPDK Getting Started Guide*.


To compile the sample application see :doc:`compiling`.

The applications are located in the ``multi_process`` sub-directory.


error: patch failed: doc/guides/sample_app_ug/multi_process.rst:8
error: doc/guides/sample_app_ug/multi_process.rst: patch does not apply
Checking patch doc/guides/sample_app_ug/packet_ordering.rst...
Checking patch doc/guides/sample_app_ug/pipeline.rst...
Checking patch doc/guides/sample_app_ug/ptpclient.rst...
error: while searching for:
PTP Client Sample Application
=============================

The PTP (Precision Time Protocol) client sample application is a simple
example of using the DPDK IEEE1588 API to communicate with a PTP master clock
to synchronize the time on the NIC and, optionally, on the Linux system.

Note, PTP is a time syncing protocol and cannot be used within DPDK as a
time-stamping mechanism. See the following for an explanation of the protocol:
`Precision Time Protocol
<https://en.wikipedia.org/wiki/Precision_Time_Protocol>`_.


Limitations
-----------

The PTP sample application is intended as a simple reference implementation of
a PTP client using the DPDK IEEE1588 API.
In order to keep the application simple the following assumptions are made:

* The first discovered master is the main for the session.
* Only L2 PTP packets are supported.
* Only the PTP v2 protocol is supported.
* Only the slave clock is implemented.


How the Application Works
-------------------------

. _figure_ptpclient_highlevel:


error: patch failed: doc/guides/sample_app_ug/ptpclient.rst:4
error: doc/guides/sample_app_ug/ptpclient.rst: patch does not apply
Checking patch doc/guides/sample_app_ug/qos_metering.rst...
Checking patch doc/guides/sample_app_ug/qos_scheduler.rst...
Checking patch doc/guides/sample_app_ug/service_cores.rst...
Checking patch doc/guides/sample_app_ug/test_pipeline.rst...
Checking patch doc/guides/sample_app_ug/timer.rst...
Checking patch doc/guides/sample_app_ug/vdpa.rst...
Checking patch doc/guides/sample_app_ug/vhost.rst...
Checking patch doc/guides/sample_app_ug/vhost_blk.rst...
Checking patch doc/guides/sample_app_ug/vhost_crypto.rst...
Checking patch doc/guides/sample_app_ug/vm_power_management.rst...
Checking patch doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst...
Checking patch doc/guides/sample_app_ug/vmdq_forwarding.rst...

|WARNING| pw151551 [PATCH v2] doc: reword sample application guides

[checkpatch]

Test-Label: checkpatch
Test-Status: WARNING
http://dpdk.org/patch/151551

_coding style issues_


WARNING:TYPO_SPELLING: 'master' may be misspelled - perhaps 'primary'?
#787: FILE: doc/guides/sample_app_ug/ptpclient.rst:11:
+the use of the DPDK IEEE1588 API to synchronize time with a PTP master clock.

WARNING:TYPO_SPELLING: 'Master' may be misspelled - perhaps 'Primary'?
#808: FILE: doc/guides/sample_app_ug/ptpclient.rst:30:
+* The first discovered Master is the main for the session.

WARNING:TYPO_SPELLING: 'Master' may be misspelled - perhaps 'Primary'?
#826: FILE: doc/guides/sample_app_ug/ptpclient.rst:47:
+* Master sends *Sync* message - the worker saves it as T2.

WARNING:TYPO_SPELLING: 'Master' may be misspelled - perhaps 'Primary'?
#829: FILE: doc/guides/sample_app_ug/ptpclient.rst:49:
+* Worker sends *Delay Request* frame to PTP Master and stores T3.

total: 0 errors, 4 warnings, 1575 lines checked