doc: capitalise PMD
authorSean Morrissey <sean.morrissey@intel.com>
Mon, 22 Nov 2021 10:50:46 +0000 (10:50 +0000)
committerDavid Marchand <david.marchand@redhat.com>
Fri, 26 Nov 2021 10:28:34 +0000 (11:28 +0100)
The doc's contain references to pmd but the proper use is to use PMD.

Cc: stable@dpdk.org
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>
13 files changed:
doc/guides/cryptodevs/ccp.rst
doc/guides/cryptodevs/openssl.rst
doc/guides/cryptodevs/overview.rst
doc/guides/eventdevs/opdl.rst
doc/guides/nics/cnxk.rst
doc/guides/nics/octeontx.rst
doc/guides/nics/octeontx2.rst
doc/guides/nics/thunderx.rst
doc/guides/prog_guide/compressdev.rst
doc/guides/rel_notes/release_18_02.rst
doc/guides/rel_notes/release_2_1.rst
doc/guides/sample_app_ug/vhost.rst
doc/guides/vdpadevs/ifc.rst

index 36dae090f9505fd94d9d00e66c57de0feb3f5514..52e98b0859a2a3f3875037218aae2ab7a6861e36 100644 (file)
@@ -100,7 +100,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
 
index 848a2e8eb8bf9606df655c8b93a04905bbb19ec1..03041ceda1c99228e018d1ebb0607c43dc6f1ffe 100644 (file)
@@ -69,7 +69,7 @@ use version 1.1.1g or newer.
 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.
index 11722979156fcc7c7d2f7cc0400d162bd8b0745a..d754b0cfc64c07b2b3c649a34049266f26323b35 100644 (file)
@@ -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
index cbfd1f11b749527aff7ec91630c5205812c67d63..f220959249ad4d233ac98680e21950c56715cfb0 100644 (file)
@@ -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).
index 837ffc02b45209ef16e814c06fac9c461032d367..84f9865654d77b4512f24d3df109c3058dd7ceec 100644 (file)
@@ -289,7 +289,7 @@ Limitations
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The OCTEON CN9K/CN10K SoC family NIC has inbuilt HW assisted external mempool manager.
-``net_cnxk`` pmd only works with ``mempool_cnxk`` mempool handler
+``net_cnxk`` PMD only works with ``mempool_cnxk`` mempool handler
 as it is performance wise most effective way for packet allocation and Tx buffer
 recycling on OCTEON TX2 SoC platform.
 
index 8236cc3e93e043a4b59910b7ef340d28febfaccf..092120815dc25c9be178b025515d32fb7ddf7380 100644 (file)
@@ -108,7 +108,7 @@ for details.
 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
@@ -126,7 +126,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:
index eae32f0afebc373735afbd6523a430016d9b978b..4ce067f2c58b63f8172f53b9bdabc7349c171c9c 100644 (file)
@@ -256,7 +256,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.
 
@@ -269,7 +269,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
@@ -278,7 +278,7 @@ OCTEON TX2 SDP interface support is limited to PF device, No VF support.
 
 Inline Protocol Processing
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
-``net_octeontx2`` pmd doesn't support the following features for packets to be
+``net_octeontx2`` PMD doesn't support the following features for packets to be
 inline protocol processed.
 - TSO offload
 - VLAN/QinQ offload
index d96395dafa4d10ef8aae227350c0043fad2e37de..5ae7e607de55a5493945424339ec96bf983ed256 100644 (file)
@@ -371,7 +371,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:
index 231687d89102886909f5ffdf8abb76f2017f59dd..07d1a62a63965d408667d663e3107d4528c918b7 100644 (file)
@@ -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)
index 989017786bf679544027a84ab6e22db6c65f7d16..af437e41537a79b6a243167034c1e722bb7999f3 100644 (file)
@@ -105,9 +105,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.**
index 0c344583164cad07bfd548644212933b5d2bab0e..35e6c888842231b463e1dcfd706e27b4d3f90059 100644 (file)
@@ -242,7 +242,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.**
index 9afde9c7f5d3cb0666e70cab8ff3f6ee1d76b31a..a6ce4bc8ac3c670be13b35040fa3c26cf786e981 100644 (file)
@@ -206,11 +206,11 @@ 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.
 
 * Device start fails when enabling "builtin-net-driver" without memory
   pre-allocation
 
   The builtin example doesn't support dynamic memory allocation. When vhost
   backend enables "builtin-net-driver", "--socket-mem" option should be
-  added at virtio-user pmd side as a startup item.
+  added at virtio-user PMD side as a startup item.
index f968489a75a8b72efee1022b423f7c93c4b59538..706dbf740e88b374398985bed5ba451aa104664b 100644 (file)
@@ -17,9 +17,9 @@ IFCVF vDPA Implementation
 IFCVF's vendor ID and device ID are same as that of virtio net pci device,
 with its specific subsystem vendor ID and device ID. To let the device be
 probed by IFCVF driver, adding "vdpa=1" parameter helps to specify that this
-device is to be used in vDPA mode, rather than polling mode, virtio pmd will
+device is to be used in vDPA mode, rather than polling mode, virtio PMD will
 skip when it detects this message. If no this parameter specified, device
-will not be used as a vDPA device, and it will be driven by virtio pmd.
+will not be used as a vDPA device, and it will be driven by virtio PMD.
 
 Different VF devices serve different virtio frontends which are in different
 VMs, so each VF needs to have its own DMA address translation service. During