From: Sean Morrissey <sean.morrissey@intel.com>
To: stable@dpdk.org, Chandubabu Namburu <chandu@amd.com>,
Declan Doherty <declan.doherty@intel.com>,
Liang Ma <liangma@liangbit.com>,
Peter Mccarthy <peter.mccarthy@intel.com>,
Harman Kalra <hkalra@marvell.com>,
Jerin Jacob <jerinj@marvell.com>,
Nithin Dabilpuram <ndabilpuram@marvell.com>,
Kiran Kumar K <kirankumark@marvell.com>,
Maciej Czekaj <mczekaj@marvell.com>,
Fan Zhang <roy.fan.zhang@intel.com>,
Ashish Gupta <ashish.gupta@marvell.com>,
Maxime Coquelin <maxime.coquelin@redhat.com>,
Chenbo Xia <chenbo.xia@intel.com>
Cc: Sean Morrissey <sean.morrissey@intel.com>,
John McNamara <john.mcnamara@intel.com>,
Conor Walsh <conor.walsh@intel.com>,
Ferruh Yigit <ferruh.yigit@intel.com>
Subject: [PATCH 19.11 v1 2/2] doc: capitalise PMD
Date: Mon, 6 Dec 2021 15:44:08 +0000 [thread overview]
Message-ID: <20211206154409.43373-2-sean.morrissey@intel.com> (raw)
In-Reply-To: <20211206154409.43373-1-sean.morrissey@intel.com>
[ upstream commit 35bd0a5c5891a59eba4a5d3904ef2e6c471a520d ]
The doc's contain references to pmd but the proper use is to use PMD.
Signed-off-by: Sean Morrissey <sean.morrissey@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
Reviewed-by: Conor Walsh <conor.walsh@intel.com>
Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
doc/guides/cryptodevs/ccp.rst | 2 +-
doc/guides/cryptodevs/openssl.rst | 2 +-
doc/guides/cryptodevs/overview.rst | 2 +-
doc/guides/eventdevs/opdl.rst | 2 +-
doc/guides/nics/octeontx.rst | 4 ++--
doc/guides/nics/octeontx2.rst | 4 ++--
doc/guides/nics/thunderx.rst | 2 +-
doc/guides/prog_guide/compressdev.rst | 6 +++---
doc/guides/rel_notes/release_18_02.rst | 4 ++--
doc/guides/rel_notes/release_2_1.rst | 2 +-
doc/guides/sample_app_ug/vhost.rst | 2 +-
11 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/doc/guides/cryptodevs/ccp.rst b/doc/guides/cryptodevs/ccp.rst
index a43fe92de..b2f786f7a 100644
--- a/doc/guides/cryptodevs/ccp.rst
+++ b/doc/guides/cryptodevs/ccp.rst
@@ -105,7 +105,7 @@ The following parameters (all optional) can be provided in the previous two call
* ccp_auth_opt: Specify authentication operations to perform on CPU using openssl APIs.
-To validate ccp pmd, l2fwd-crypto example can be used with following command:
+To validate ccp PMD, l2fwd-crypto example can be used with following command:
.. code-block:: console
diff --git a/doc/guides/cryptodevs/openssl.rst b/doc/guides/cryptodevs/openssl.rst
index 740729481..360c49851 100644
--- a/doc/guides/cryptodevs/openssl.rst
+++ b/doc/guides/cryptodevs/openssl.rst
@@ -83,7 +83,7 @@ This code has NOT been verified on FreeBSD yet.
Initialization
--------------
-User can use app/test application to check how to use this pmd and to verify
+User can use app/test application to check how to use this PMD and to verify
crypto processing.
Test name is cryptodev_openssl_autotest.
diff --git a/doc/guides/cryptodevs/overview.rst b/doc/guides/cryptodevs/overview.rst
index e2a1e08ec..f9a58fbd3 100644
--- a/doc/guides/cryptodevs/overview.rst
+++ b/doc/guides/cryptodevs/overview.rst
@@ -19,7 +19,7 @@ Supported Feature Flags
- "OOP SGL In SGL Out" feature flag stands for
"Out-of-place Scatter-gather list Input, Scatter-gather list Output",
- which means pmd supports different scatter-gather styled input and output buffers
+ which means PMD supports different scatter-gather styled input and output buffers
(i.e. both can consists of multiple segments).
- "OOP SGL In LB Out" feature flag stands for
diff --git a/doc/guides/eventdevs/opdl.rst b/doc/guides/eventdevs/opdl.rst
index cbfd1f11b..f22095924 100644
--- a/doc/guides/eventdevs/opdl.rst
+++ b/doc/guides/eventdevs/opdl.rst
@@ -87,7 +87,7 @@ due to the static nature of the underlying queues. It is because of this
that the implementation can achieve such high throughput and low latency
The following list is a comprehensive outline of the what is supported and
-the limitations / restrictions imposed by the opdl pmd
+the limitations / restrictions imposed by the opdl PMD
- The order in which packets moved between queues is static and fixed \
(dynamic scheduling is not supported).
diff --git a/doc/guides/nics/octeontx.rst b/doc/guides/nics/octeontx.rst
index 8fc53810b..c015127b4 100644
--- a/doc/guides/nics/octeontx.rst
+++ b/doc/guides/nics/octeontx.rst
@@ -122,7 +122,7 @@ following ``make`` command:
Initialization
--------------
-The OCTEON TX ethdev pmd is exposed as a vdev device which consists of a set
+The OCTEON TX ethdev PMD is exposed as a vdev device which consists of a set
of PKI and PKO PCIe VF devices. On EAL initialization,
PKI/PKO PCIe VF devices will be probed and then the vdev device can be created
from the application code, or from the EAL command line based on
@@ -140,7 +140,7 @@ the number of interesting ports with ``nr_ports`` argument.
Dependency
~~~~~~~~~~
-``eth_octeontx`` pmd is depend on ``event_octeontx`` eventdev device and
+``eth_octeontx`` PMD is depend on ``event_octeontx`` eventdev device and
``octeontx_fpavf`` external mempool handler.
Example:
diff --git a/doc/guides/nics/octeontx2.rst b/doc/guides/nics/octeontx2.rst
index cad4a7592..9c341169f 100644
--- a/doc/guides/nics/octeontx2.rst
+++ b/doc/guides/nics/octeontx2.rst
@@ -191,7 +191,7 @@ Limitations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The OCTEON TX2 SoC family NIC has inbuilt HW assisted external mempool manager.
-``net_octeontx2`` pmd only works with ``mempool_octeontx2`` mempool handler
+``net_octeontx2`` PMD only works with ``mempool_octeontx2`` mempool handler
as it is performance wise most effective way for packet allocation and Tx buffer
recycling on OCTEON TX2 SoC platform.
@@ -204,7 +204,7 @@ the host interface irrespective of the offload configuration.
Multicast MAC filtering
~~~~~~~~~~~~~~~~~~~~~~~
-``net_octeontx2`` pmd supports multicast mac filtering feature only on physical
+``net_octeontx2`` PMD supports multicast mac filtering feature only on physical
function devices.
SDP interface support
diff --git a/doc/guides/nics/thunderx.rst b/doc/guides/nics/thunderx.rst
index 1f6ee1ff0..8958b08f6 100644
--- a/doc/guides/nics/thunderx.rst
+++ b/doc/guides/nics/thunderx.rst
@@ -320,7 +320,7 @@ Module params
skip_data_bytes
~~~~~~~~~~~~~~~
This feature is used to create a hole between HEADROOM and actual data. Size of hole is specified
-in bytes as module param("skip_data_bytes") to pmd.
+in bytes as module param("skip_data_bytes") to PMD.
This scheme is useful when application would like to insert vlan header without disturbing HEADROOM.
Example:
diff --git a/doc/guides/prog_guide/compressdev.rst b/doc/guides/prog_guide/compressdev.rst
index a089db1fa..dbdcbef4e 100644
--- a/doc/guides/prog_guide/compressdev.rst
+++ b/doc/guides/prog_guide/compressdev.rst
@@ -28,7 +28,7 @@ From the command line using the --vdev EAL option
.. code-block:: console
- --vdev '<pmd name>,socket_id=0'
+ --vdev '<PMD name>,socket_id=0'
.. Note::
@@ -332,7 +332,7 @@ using priv_xform would look like:
* pseudocode for stateless compression
*/
- uint8_t cdev_id = rte_compressdev_get_dev_id(<pmd name>);
+ uint8_t cdev_id = rte_compressdev_get_dev_id(<PMD name>);
/* configure the device. */
if (rte_compressdev_configure(cdev_id, &conf) < 0)
@@ -475,7 +475,7 @@ An example pseudocode to set up and process a stream having NUM_CHUNKS with each
* pseudocode for stateful compression
*/
- uint8_t cdev_id = rte_compressdev_get_dev_id(<pmd name>);
+ uint8_t cdev_id = rte_compressdev_get_dev_id(<PMD name>);
/* configure the device. */
if (rte_compressdev_configure(cdev_id, &conf) < 0)
diff --git a/doc/guides/rel_notes/release_18_02.rst b/doc/guides/rel_notes/release_18_02.rst
index 3523ea7fd..4a1b8a92d 100644
--- a/doc/guides/rel_notes/release_18_02.rst
+++ b/doc/guides/rel_notes/release_18_02.rst
@@ -142,9 +142,9 @@ New Features
* ``VIRTIO_NET_F_GUEST_UFO``, ``VIRTIO_NET_F_HOST_UFO``
* ``VIRTIO_NET_F_GSO``
- Also added ``VIRTIO_NET_F_GUEST_ANNOUNCE`` feature support in virtio pmd.
+ Also added ``VIRTIO_NET_F_GUEST_ANNOUNCE`` feature support in virtio PMD.
In a scenario where the vhost backend doesn't have the ability to generate
- RARP packets, the VM running virtio pmd can still be live migrated if
+ RARP packets, the VM running virtio PMD can still be live migrated if
``VIRTIO_NET_F_GUEST_ANNOUNCE`` feature is negotiated.
* **Updated the AESNI-MB PMD.**
diff --git a/doc/guides/rel_notes/release_2_1.rst b/doc/guides/rel_notes/release_2_1.rst
index beadc51ba..eb390a094 100644
--- a/doc/guides/rel_notes/release_2_1.rst
+++ b/doc/guides/rel_notes/release_2_1.rst
@@ -243,7 +243,7 @@ New Features
* **Added fm10k jumbo frame support.**
Added support for jumbo frame less than 15K in both VF and PF functions in the
- fm10k pmd.
+ fm10k PMD.
* **Added fm10k mac vlan filtering support.**
diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst
index 66e804d63..881ea21e6 100644
--- a/doc/guides/sample_app_ug/vhost.rst
+++ b/doc/guides/sample_app_ug/vhost.rst
@@ -200,4 +200,4 @@ Common Issues
* Option "builtin-net-driver" is incompatible with QEMU
QEMU vhost net device start will fail if protocol feature is not negotiated.
- DPDK virtio-user pmd can be the replacement of QEMU.
+ DPDK virtio-user PMD can be the replacement of QEMU.
--
2.25.1
next prev parent reply other threads:[~2021-12-06 15:45 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-06 15:44 [PATCH 19.11 v1 1/2] fix PMD wording Sean Morrissey
2021-12-06 15:44 ` Sean Morrissey [this message]
2021-12-06 16:41 ` [PATCH 19.11 v1 2/2] doc: capitalise PMD Christian Ehrhardt
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=20211206154409.43373-2-sean.morrissey@intel.com \
--to=sean.morrissey@intel.com \
--cc=ashish.gupta@marvell.com \
--cc=chandu@amd.com \
--cc=chenbo.xia@intel.com \
--cc=conor.walsh@intel.com \
--cc=declan.doherty@intel.com \
--cc=ferruh.yigit@intel.com \
--cc=hkalra@marvell.com \
--cc=jerinj@marvell.com \
--cc=john.mcnamara@intel.com \
--cc=kirankumark@marvell.com \
--cc=liangma@liangbit.com \
--cc=maxime.coquelin@redhat.com \
--cc=mczekaj@marvell.com \
--cc=ndabilpuram@marvell.com \
--cc=peter.mccarthy@intel.com \
--cc=roy.fan.zhang@intel.com \
--cc=stable@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;
as well as URLs for NNTP newsgroup(s).