Skip to contentSkip to conversation

reowrd in prog guide

PATCH In review Nandini Persad 4 participants 119 messages May 13, 2024 – Jul 17 Arm/Amlogic Meson SoC support Page 2 of 2

lore
Share & tools
lore
#103 lore raw

PATCH v5 40/54 doc: correct typos in packet distributor guide

In reply to Stephen Hemminger

Correct various issues in the packet distributor documentation:

- remove extra space after "each"
- fix typo "work" to "worker" in queue description
- fix "of less use that" to "of less use than"
- fix inconsistent capitalization "APIS" to "APIs"

---
 doc/guides/prog_guide/packet_distrib_lib.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
doc/guides/prog_guide/packet_distrib_lib.rst +3 -3
index 3c3b746aca..10e187be04 100644
@@ -33,11 +33,11 @@ The operation of the distributor is as follows:
 
 #.  As workers request packets, the distributor takes packets from the set of packets passed in and distributes them to the workers.
     As it does so, it examines the "tag" -- stored in the RSS hash field in the mbuf -- for each packet
-    and records what tags are being processed by each  worker.
+    and records what tags are being processed by each worker.
 
 #.  If the next packet in the input set has a tag which is already being processed by a worker,
     then that packet will be queued up for processing by that worker
-    and given to it in preference to other packets when that work next makes a request for work.
+    and given to it in preference to other packets when that worker next makes a request for work.
     This ensures that no two packets with the same tag are processed in parallel,
     and that all packets with the same tag are processed in input order.
 
@@ -78,7 +78,7 @@ while allowing packet order within a packet flow -- identified by a tag -- to be
 
 
 The flush and clear_returns API calls, mentioned previously,
-are likely of less use that the process and returned_pkts APIS, and are principally provided to aid in unit testing of the library.
+are likely of less use than the process and returned_pkts APIs, and are principally provided to aid in unit testing of the library.
 Descriptions of these functions and their use can be found in the DPDK API Reference document.
 
 Worker Operation
Signature · 1 line
2.51.0
#104 lore raw

PATCH v5 41/54 doc: correct grammar in packet framework guide

In reply to Stephen Hemminger

Correct various issues in the packet framework documentation:

- add missing article "a" in "As a result of lookup"
- fix incomplete sentence "described in." to "described below."
- fix confusing mirror/main copy swap description that had duplicate text and fix subject-verb agreement

---
 doc/guides/prog_guide/packet_framework.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
doc/guides/prog_guide/packet_framework.rst +3 -3
index 17010b07dc..cacda9add2 100644
@@ -34,7 +34,7 @@ as well as providing libraries of reusable templates for the commonly used pipel
 
 The pipeline is constructed by connecting the set of input ports with the set of output ports
 through the set of tables in a tree-like topology.
-As result of lookup operation for the current packet in the current table,
+As a result of lookup operation for the current packet in the current table,
 one of the table entries (on lookup hit) or the default table entry (on lookup miss)
 provides the set of actions to be applied on the current packet,
 as well as the next hop for the packet, which can be either another table, an output port or packet drop.
@@ -106,7 +106,7 @@ Port Interface
 Each port is unidirectional, i.e. either input port or output port.
 Each input/output port is required to implement an abstract interface that
 defines the initialization and run-time operation of the port.
-The port abstract interface is described in.
+The port abstract interface is described below.
 
 .. _table_qos_20:
 
@@ -1128,7 +1128,7 @@ Mechanisms to share the same table between multiple threads:
 
 #.  **Single writer thread performing table entry add/delete operations and multiple reader threads that perform table lookup operations with read-only access to the table entries.**
     The reader threads use the main table copy while the writer is updating the mirror copy.
-    Once the writer update is done, the writer can signal to the readers and busy wait until all readers swaps between the mirror copy (which now becomes the main copy) and
+    Once the writer update is done, the writer can signal to the readers and busy wait until all readers swap between the main copy (which now becomes the mirror copy) and
     the mirror copy (which now becomes the main copy).
 
 Interfacing with Accelerators
Signature · 1 line
2.51.0
#105 lore raw

PATCH v5 42/54 doc: correct grammar in PDCP library guide

In reply to Stephen Hemminger

Correct various grammar issues in the PDCP library documentation:

- use "high-performance" instead of nonstandard "high performant"
- add missing articles and fix pluralization for APIs
- use present tense consistently instead of "would" conditional since the library is implemented and we're describing current behavior
- fix subject-verb agreement in multiple places

---
 doc/guides/prog_guide/pdcp_lib.rst | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)
doc/guides/prog_guide/pdcp_lib.rst +12 -12
index 266abb8574..4123dcfde9 100644
@@ -7,7 +7,7 @@ PDCP Protocol Processing Library
 DPDK provides a library for PDCP protocol processing.
 The library utilizes other DPDK libraries such as cryptodev, reorder, etc.,
 to provide the application with a transparent and
-high performant PDCP protocol processing library.
+high-performance PDCP protocol processing library.
 
 The library abstracts complete PDCP protocol processing conforming to
 `ETSI TS 138 323 V17.1.0 (2022-08)
@@ -34,27 +34,27 @@ to work with cryptodev irrespective of the protocol offload features supported.
 PDCP entity API
 ---------------
 
-PDCP library provides following control path API that is used to
+PDCP library provides the following control path APIs that are used to
 configure various PDCP entities:
 
 - ``rte_pdcp_entity_establish()``
 - ``rte_pdcp_entity_suspend()``
 - ``rte_pdcp_entity_release()``
 
-A PDCP entity would translate to one ``rte_cryptodev_sym_session`` or
+A PDCP entity translates to one ``rte_cryptodev_sym_session`` or
 ``rte_security_session`` based on the config.
 The sessions would be created/destroyed
 while corresponding PDCP entity operations are performed.
 
 When upper layers request a PDCP entity suspend (``rte_pdcp_entity_suspend()``),
-it would result in flushing out of all cached packets and
+it results in flushing out of all cached packets and
 internal state variables are updated as described in 5.1.4.
 
 When upper layers request a PDCP entity release (``rte_pdcp_entity_release()``),
-it would result in flushing out of all cached packets
+it results in flushing out of all cached packets
 and releasing of all memory associated with the entity.
-It would internally free any crypto/security sessions created.
-All procedures mentioned in 5.1.3 would be performed.
+It internally frees any crypto/security sessions created.
+All procedures mentioned in 5.1.3 are performed.
 
 PDCP PDU (Protocol Data Unit) API
 ---------------------------------
@@ -84,8 +84,8 @@ PDCP packet processing API for control PDU
 
 Control PDUs are used in PDCP as a communication channel
 between transmitting and receiving entities.
-When upper layer request for operations such as re-establishment,
-receiving PDCP entity need to prepare a status report
+When upper layers request operations such as re-establishment,
+the receiving PDCP entity needs to prepare a status report
 and send it to the other end.
 The API ``rte_pdcp_control_pdu_create()`` allows application to request the same.
 
@@ -99,13 +99,13 @@ Since cryptodev dequeue can return crypto operations
 belonging to multiple entities, ``rte_pdcp_pkt_crypto_group()``
 is added to help grouping crypto operations belonging to same PDCP entity.
 
-Lib PDCP would allow application to use same API sequence
+Lib PDCP allows the application to use the same API sequence
 while leveraging protocol offload features enabled by ``rte_security`` library.
 
-Lib PDCP would internally change the handles registered
+Lib PDCP internally changes the handles registered
 for ``pre_process`` and ``post_process`` based on features enabled in the entity.
 
-Lib PDCP would create the required sessions on the device
+Lib PDCP creates the required sessions on the device
 provided in entity to minimize the application requirements.
 Also, the ``rte_crypto_op`` allocation and free would also be done internally
 by lib PDCP to allow the library to create crypto ops as required for the input packets.
Signature · 1 line
2.51.0
#106 lore raw

PATCH v5 43/54 doc: correct grammar in pdump library guide

In reply to Stephen Hemminger

Correct various grammar issues in the pdump library documentation:

- fix "both...or" to "both...and"
- fix "maybe" to "may be" (two separate words)
- add missing article "the" before "application"

---
 doc/guides/prog_guide/pdump_lib.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
doc/guides/prog_guide/pdump_lib.rst +3 -3
index 5bacb49ffc..d27385fef1 100644
@@ -7,7 +7,7 @@ Packet Capture Library
 The DPDK ``pdump`` library provides a framework
 for capturing packets within DPDK applications.
 It enables a **secondary process** to monitor packets
-being processed by both **primary** or **secondary** processes.
+being processed by both **primary** and **secondary** processes.
 
 
 Overview
@@ -76,7 +76,7 @@ The library exposes API for:
 .. function:: int rte_pdump_stats(uint16_t port_id, struct rte_dump_stats *stats)
 
    Reports the number of packets captured, filtered, and missed.
-   Packets maybe missed due to mbuf pool being exhausted or the ring being full.
+   Packets may be missed due to mbuf pool being exhausted or the ring being full.
 
 
 Operation
@@ -128,7 +128,7 @@ What is the performance impact of pdump?
 
 What happens if process does not call pdump init?
 
-   If application does not call ``rte_pdump_init``
+   If the application does not call ``rte_pdump_init``
    then the request to enable (in the capture command)
    will timeout and an error is returned.
 
Signature · 1 line
2.51.0
#107 lore raw

PATCH v5 44/54 doc: correct typos in power management guide

In reply to Stephen Hemminger

Correct various typos in the power management documentation:

- fix "users space" to "user space"
- fix "according the" to "according to the"
- fix section title "User Cases" to "Use Cases"
- fix "die's" to "dies" (no apostrophe for plural)

---
 doc/guides/prog_guide/power_man.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
doc/guides/prog_guide/power_man.rst +4 -4
index 74039e5786..b4c9271e0b 100644
@@ -4,7 +4,7 @@
 Power Management
 ================
 
-The DPDK Power Management feature allows users space applications to save power
+The DPDK Power Management feature allows user space applications to save power
 by dynamically adjusting CPU frequency or entering into different C-States.
 
 *   Adjusting the CPU frequency dynamically according to the utilization of RX queue.
@@ -60,7 +60,7 @@ Core-load Throttling through C-States
 
 Core state can be altered by speculative sleeps whenever the specified lcore has nothing to do.
 In the DPDK, if no packet is received after polling,
-speculative sleeps can be triggered according the strategies defined by the user space application.
+speculative sleeps can be triggered according to the strategies defined by the user space application.
 
 Per-core Turbo Boost
 --------------------
@@ -101,7 +101,7 @@ The main methods exported by power library are for CPU frequency scaling and inc
 
 *   **Disable turbo**: Prompt the kernel to disable Turbo Boost for the specific lcore.
 
-User Cases
+Use Cases
 ----------
 
 The power management mechanism is used to save power when performing L3 forwarding.
@@ -285,7 +285,7 @@ Get Num Pkgs
   Get the number of packages (CPU's) on the system.
 
 Get Num Dies
-  Get the number of die's on a given package.
+  Get the number of dies on a given package.
 
 References
 ----------
Signature · 1 line
2.51.0
#108 lore raw

PATCH v5 45/54 doc: correct grammar in profiling guide

In reply to Stephen Hemminger

Correct subject-verb agreement: "architecture provides" not "provide".

---
 doc/guides/prog_guide/profile_app.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/guides/prog_guide/profile_app.rst +1 -1
index 2f47680d5d..b2950c2a61 100644
@@ -88,7 +88,7 @@ Profiling on ARM64
 Using Linux perf
 ~~~~~~~~~~~~~~~~
 
-The ARM64 architecture provide performance counters to monitor events.  The
+The ARM64 architecture provides performance counters to monitor events.  The
 Linux ``perf`` tool can be used to profile and benchmark an application.  In
 addition to the standard events, ``perf`` can be used to profile arm64
 specific PMU (Performance Monitor Unit) events through raw events (``-e``
Signature · 1 line
2.51.0
#109 lore raw

PATCH v5 46/54 doc: correct errors in regexdev guide

In reply to Stephen Hemminger

Correct various issues in the RegEx device library documentation:

- fix "Crypto" to "RegEx" in framework description (copy-paste error)
- fix "ReEx" typo to "RegEx"
- remove extra space after "for example"
- fix "in being compiled" to "is being compiled"
- fix "depended" to "dependent"
- fix subject-verb agreement "add / remove" to "adds / removes"
- add missing article "a" before "number of queue pairs"
- fix "feature set" to "feature sets" and complete broken sentence
- fix "it's" to "its"
- fix garbled sentence about data release timing
- fix awkward "API of processed but" phrasing

---
 doc/guides/prog_guide/regexdev.rst | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)
doc/guides/prog_guide/regexdev.rst +12 -12
index 3bf3b154b4..2b4f26263e 100644
@@ -14,7 +14,7 @@ Design Principles
 
 The RegEx library follows the same basic principles as those used in DPDK's
 Ethernet Device framework and the Crypto framework. The RegEx framework provides
-a generic Crypto device framework which supports both physical (hardware)
+a generic RegEx device framework which supports both physical (hardware)
 and virtual (software) RegEx devices as well as a generic RegEx API which allows
 RegEx devices to be managed and configured and supports RegEx operations to be
 provisioned on RegEx poll mode driver.
@@ -29,7 +29,7 @@ Device Creation
 Physical RegEx devices are discovered during the PCI probe/enumeration of the
 EAL function which is executed at DPDK initialization, based on
 their PCI device identifier, each unique PCI BDF (bus/bridge, device,
-function). Specific physical ReEx devices, like other physical devices in DPDK
+function). Specific physical RegEx devices, like other physical devices in DPDK
 can be listed using the EAL command line options.
 
 
@@ -63,7 +63,7 @@ The rte_regexdev_configure API is used to configure a RegEx device.
                               const struct rte_regexdev_config *cfg);
 
 The ``rte_regexdev_config`` structure is used to pass the configuration
-parameters for the RegEx device for example  number of queue pairs, number of
+parameters for the RegEx device for example number of queue pairs, number of
 groups, max number of matches and so on.
 
 .. code-block:: c
@@ -117,13 +117,13 @@ Configuration of Rules Database
 
 Each Regex device should be configured with the rule database.
 There are two modes of setting the rule database, online or offline.
-The online mode means, that the rule database in being compiled by the
+The online mode means that the rule database is being compiled by the
 RegEx PMD while in the offline mode the rule database is compiled by external
 compiler, and is being loaded to the PMD as a buffer.
-The configuration mode is depended on the PMD capabilities.
+The configuration mode is dependent on the PMD capabilities.
 
 Online rule configuration is done using the following API functions:
-``rte_regexdev_rule_db_update`` which add / remove rules from the rules
+``rte_regexdev_rule_db_update`` which adds / removes rules from the rules
 precompiled list.
 
 Offline rule configuration can be done by adding a pointer to the compiled
@@ -134,7 +134,7 @@ rule database in the configuration step, or by using
 Configuration of Queue Pairs
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Each RegEx device can be configured with number of queue pairs.
+Each RegEx device can be configured with a number of queue pairs.
 Each queue pair is configured using ``rte_regexdev_queue_pair_setup``
 
 
@@ -149,9 +149,9 @@ require global locks and hinder performance.
 Device Features and Capabilities
 ---------------------------------
 
-RegEx devices may support different feature set.
-In order to get the supported PMD feature ``rte_regexdev_info_get``
-API which return the info of the device and it's supported features.
+RegEx devices may support different feature sets.
+In order to get the supported PMD features, use the ``rte_regexdev_info_get``
+API which returns the info of the device and its supported features.
 
 
 Enqueue / Dequeue Burst APIs
@@ -165,10 +165,10 @@ The enqueue function returns the number of operations it actually enqueued for
 processing, a return value equal to ``nb_ops`` means that all packets have been
 enqueued.
 
-Data pointed in each op, should not be released until the dequeue of for that
+Data pointed to by each op should not be released until the dequeue for that
 op.
 
-The dequeue API uses the same format as the enqueue API of processed but
+The dequeue API uses the same format as the enqueue API but
 the ``nb_ops`` and ``ops`` parameters are now used to specify the max processed
 operations the user wishes to retrieve and the location in which to store them.
 The API call returns the actual number of processed operations returned, this
Signature · 1 line
2.51.0
#110 lore raw

PATCH v5 47/54 doc: correct grammar in reorder library guide

In reply to Stephen Hemminger

Correct minor grammar issues in the reorder library documentation:

- add missing "are" in "which are referred to as"
- remove extra space before "mbufs"

---
 doc/guides/prog_guide/reorder_lib.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
doc/guides/prog_guide/reorder_lib.rst +2 -2
index 3fb5df5570..a5f529145d 100644
@@ -36,7 +36,7 @@ mbufs.
 Implementation Details
 -------------------------
 
-The reorder library is implemented as a pair of buffers, which referred to as
+The reorder library is implemented as a pair of buffers, which are referred to as
 the *Order* buffer and the *Ready* buffer.
 
 On an insert call, valid mbufs are inserted directly into the Order buffer and
@@ -62,7 +62,7 @@ be reported as late packets when they arrive. The process of moving packets
 to the Ready buffer continues beyond the minimum required until a gap,
 i.e. missing mbuf, in the Order buffer is encountered.
 
-When draining mbufs, the reorder buffer would return  mbufs in the Ready
+When draining mbufs, the reorder buffer would return mbufs in the Ready
 buffer first and then from the Order buffer until a gap is found (mbufs that
 have not arrived yet).
 
Signature · 1 line
2.51.0
#111 lore raw

PATCH v5 48/54 doc: correct whitespace in RIB library guide

In reply to Stephen Hemminger

Remove extra space before "the" in API applicability note.

---
 doc/guides/prog_guide/rib_lib.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/guides/prog_guide/rib_lib.rst +1 -1
index 40b7de3f1d..e95d85b2d1 100644
@@ -24,7 +24,7 @@ Next hop IDs are represented by ``uint64_t`` values.
 
    The API and implementation are very similar for IPv4 ``rte_rib`` API and IPv6 ``rte_rib6``
    API, therefore only the ``rte_rib`` API will be discussed here.
-   Everything within this document except for the size of the prefixes is applicable to  the
+   Everything within this document except for the size of the prefixes is applicable to the
    ``rte_rib6`` API.
 
 Internally RIB is represented as a binary tree as shown in :numref:`figure_rib_internals`:
Signature · 1 line
2.51.0
#112 lore raw

PATCH v5 49/54 doc: correct incomplete sentence in ring library guide

In reply to Stephen Hemminger

Correct incomplete sentence "is shown in with" to "is shown in the figure below, with".

---
 doc/guides/prog_guide/ring_lib.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/guides/prog_guide/ring_lib.rst +1 -1
index 98ef003aac..8e1dec288d 100644
@@ -43,7 +43,7 @@ The disadvantages:
 
 *   Having many rings costs more in terms of memory than a linked list queue. An empty ring contains at least N objects.
 
-A simplified representation of a Ring is shown in with consumer and producer head and tail pointers to objects stored in the data structure.
+A simplified representation of a Ring is shown in the figure below, with consumer and producer head and tail pointers to objects stored in the data structure.
 
 .. _figure_ring1:
 
Signature · 1 line
2.51.0
#113 lore raw

PATCH v5 50/54 doc: correct grammar in security library guide

In reply to Stephen Hemminger

Correct grammar issues in the security library documentation:

- fix "will contains" to "will contain"
- fix "in a optimal way" to "in an optimal way"

---
 doc/guides/prog_guide/rte_security.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
doc/guides/prog_guide/rte_security.rst +2 -2
index 5cfa39a71d..837acadfde 100644
@@ -120,7 +120,7 @@ crypto processing the packet is presented to the host as a regular Rx packet
 but all security protocol related headers are optionally removed from the
 packet. e.g. in the case of IPsec, the IPsec tunnel headers (if any),
 ESP/AH headers will be removed from the packet and the received packet
-will contains the decrypted packet only. The driver Rx path checks the
+will contain the decrypted packet only. The driver Rx path checks the
 descriptors and based on the crypto status sets additional flags in
 ``rte_mbuf.ol_flags`` field. The driver would also set device-specific
 metadata in ``RTE_SECURITY_DYNFIELD_NAME`` field.
@@ -696,7 +696,7 @@ Security Sessions are created to store the immutable fields of a particular Secu
 Association for a particular protocol which is defined by a security session
 configuration structure which is used in the operation processing of a packet flow.
 Sessions are used to manage protocol specific information as well as crypto parameters.
-Security sessions cache this immutable data in a optimal way for the underlying PMD
+Security sessions cache this immutable data in an optimal way for the underlying PMD
 and this allows further acceleration of the offload of Crypto workloads.
 
 The Security framework provides APIs to create and free sessions for crypto/ethernet
Signature · 1 line
2.51.0
#114 lore raw

PATCH v5 51/54 doc: correct hyphenation in thread safety guide

In reply to Stephen Hemminger

Correct spurious space in "thread- safe" to "thread-safe".

---
 doc/guides/prog_guide/thread_safety.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/guides/prog_guide/thread_safety.rst +1 -1
index f7cda8bb32..e3e1a567e9 100644
@@ -11,7 +11,7 @@ This section allows the developer to take these issues into account when buildin
 The run-time environment of the DPDK is typically a single thread per logical core.
 In some cases, it is not only multi-threaded, but multi-process.
 Typically, it is best to avoid sharing data structures between threads and/or processes where possible.
-Where this is not possible, then the execution blocks must access the data in a thread- safe manner.
+Where this is not possible, then the execution blocks must access the data in a thread-safe manner.
 Mechanisms such as atomics or locking can be used that will allow execution blocks to operate serially.
 However, this can have an effect on the performance of the application.
 
Signature · 1 line
2.51.0
#115 lore raw

PATCH v5 52/54 doc: correct errors in toeplitz hash library guide

In reply to Stephen Hemminger

Correct sentence fragment "Could be used" to "They can be used". Correct typo in code example: rte_thash_get_compliment should be
rte_thash_get_complement to match the actual API

---
 doc/guides/prog_guide/toeplitz_hash_lib.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
doc/guides/prog_guide/toeplitz_hash_lib.rst +2 -2
index 61eaafd169..cc22236836 100644
@@ -40,7 +40,7 @@ The ``rte_softrss_be`` function is a faster implementation,
 but it expects ``rss_key`` to be converted to the host byte order.
 
 The last two functions are vectorized implementations using
-Galois Fields New Instructions. Could be used if ``rte_thash_gfni_supported`` is true.
+Galois Fields New Instructions. They can be used if ``rte_thash_gfni_supported`` is true.
 They expect the tuple to be in network byte order.
 
 ``rte_thash_gfni()`` calculates the hash value for a single tuple, and
@@ -306,7 +306,7 @@ collision. This is shown in the code below.
    uint32_t rev_hash = rte_softrss((uint32_t *)&rev_tuple, RTE_THASH_V4_L4_LEN, new_key);
 
    /* Get the adjustment bits for the src port to get a new port. */
-   uint32_t adj = rte_thash_get_compliment(h, rev_hash, orig_hash);
+   uint32_t adj = rte_thash_get_complement(h, rev_hash, orig_hash);
 
    /* Adjust the source port bits. */
    uint16_t new_sport = tuple.v4.sport ^ adj;
Signature · 1 line
2.51.0
#116 lore raw

PATCH v5 53/54 doc: correct errors in vhost library guide

In reply to Stephen Hemminger

Correct various issues in the vhost library documentation:

- fix "In another words" to "In other words"
- fix word order "for given a packet" to "for a given packet"
- fix "to be dequeue" to "to be dequeued"
- fix typo "pkmbuf" to "pktmbuf"
- fix plural agreement "application that doesn't" to "applications that don't"
- add missing period after NET_STATS_ENABLE description
- fix subject-verb agreement "features is" to "features are"
- fix verb tense "stored them at" to "stores them in"
- fix awkward phrasing in DMA vChannel cleanup description
- fix "which responses to create" to "which is responsible for creating"
- fix "to response" to "to respond"

---
 doc/guides/prog_guide/vhost_lib.rst | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)
doc/guides/prog_guide/vhost_lib.rst +11 -11
index 0c2b4d020a..345a621716 100644
@@ -5,7 +5,7 @@ Vhost Library
 =============
 
 The vhost library implements a user space virtio net server allowing the user
-to manipulate the virtio ring directly. In another words, it allows the user
+to manipulate the virtio ring directly. In other words, it allows the user
 to fetch/put packets from/to the VM virtio net device. To achieve this, a
 vhost library should be able to:
 
@@ -73,7 +73,7 @@ The following is an overview of some key Vhost API functions:
     Enabling this flag forces vhost dequeue function to only provide linear
     pktmbuf (no multi-segmented pktmbuf).
 
-    The vhost library by default provides a single pktmbuf for given a
+    The vhost library by default provides a single pktmbuf for a given
     packet, but if for some reason the data doesn't fit into a single
     pktmbuf (e.g., TSO is enabled), the library will allocate additional
     pktmbufs from the same mempool and chain them together to create a
@@ -81,7 +81,7 @@ The following is an overview of some key Vhost API functions:
 
     However, the vhost application needs to support multi-segmented format.
     If the vhost application does not support that format and requires large
-    buffers to be dequeue, this flag should be enabled to force only linear
+    buffers to be dequeued, this flag should be enabled to force only linear
     buffers (see RTE_VHOST_USER_EXTBUF_SUPPORT) or drop the packet.
 
     It is disabled by default.
@@ -89,7 +89,7 @@ The following is an overview of some key Vhost API functions:
   - ``RTE_VHOST_USER_EXTBUF_SUPPORT``
 
     Enabling this flag allows vhost dequeue function to allocate and attach
-    an external buffer to a pktmbuf if the pkmbuf doesn't provide enough
+    an external buffer to a pktmbuf if the pktmbuf doesn't provide enough
     space to store all data.
 
     This is useful when the vhost application wants to support large packets
@@ -99,7 +99,7 @@ The following is an overview of some key Vhost API functions:
     rte_pktmbuf_attach_extbuf().
 
     See RTE_VHOST_USER_LINEARBUF_SUPPORT as well to disable multi-segmented
-    mbufs for application that doesn't support chained mbufs.
+    mbufs for applications that don't support chained mbufs.
 
     It is disabled by default.
 
@@ -137,7 +137,7 @@ The following is an overview of some key Vhost API functions:
   rte_vhost_stats_get() to collect statistics, and rte_vhost_stats_reset() to
   reset them.
 
-  It is disabled by default
+  It is disabled by default.
 
 * ``rte_vhost_driver_set_features(path, features)``
 
@@ -167,7 +167,7 @@ The following is an overview of some key Vhost API functions:
 
   * ``features_changed(int vid, uint64_t features)``
 
-    This callback is invoked when the features is changed. For example,
+    This callback is invoked when the features are changed. For example,
     ``VHOST_F_LOG_ALL`` will be set/cleared at the start/end of live
     migration, respectively.
 
@@ -200,7 +200,7 @@ The following is an overview of some key Vhost API functions:
 
 * ``rte_vhost_dequeue_burst(vid, queue_id, mbuf_pool, pkts, count)``
 
-  Receives (dequeues) ``count`` packets from guest, and stored them at ``pkts``.
+  Receives (dequeues) ``count`` packets from guest, and stores them in ``pkts``.
 
 * ``rte_vhost_crypto_create(vid, cryptodev_id, sess_mempool, socket_id)``
 
@@ -331,7 +331,7 @@ The following is an overview of some key Vhost API functions:
 
 * ``rte_vhost_async_dma_unconfigure(dma_id, vchan_id)``
 
-  Clean DMA vChannel finished to use. After this function is called,
+  Clean up a DMA vChannel after use is finished. After this function is called,
   the specified DMA vChannel should no longer be used by the Vhost library.
 
 * ``rte_vhost_notify_guest(int vid, uint16_t queue_id)``
@@ -360,7 +360,7 @@ vhost-user implementation has two options:
 * DPDK vhost-user acts as the client.
 
   Unlike the server mode, this mode doesn't create the socket file;
-  it just tries to connect to the server (which responses to create the
+  it just tries to connect to the server (which is responsible for creating the
   file instead).
 
   When the DPDK vhost-user application restarts, DPDK vhost-user will try to
@@ -469,7 +469,7 @@ Finally, a set of device ops is defined for device specific operations:
 
 * ``migration_done``
 
-  Called to allow the device to response to RARP sending.
+  Called to allow the device to respond to RARP sending.
 
 * ``get_vfio_group_fd``
 
Signature · 1 line
2.51.0
#117 lore raw

PATCH v5 54/54 doc: correct whitespace in efficient code guide

In reply to Stephen Hemminger

Remove extra space in "rte_malloc ()" function name reference.

---
 doc/guides/prog_guide/writing_efficient_code.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/guides/prog_guide/writing_efficient_code.rst +1 -1
index b63fa8e459..6fbdb57fa8 100644
@@ -41,7 +41,7 @@ If you really need dynamic allocation in the data plane, it is better to use a m
 This API is provided by librte_mempool.
 This data structure provides several services that increase performance, such as memory alignment of objects,
 lockless access to objects, NUMA awareness, bulk get/put and per-lcore cache.
-The rte_malloc () function uses a similar concept to mempools.
+The rte_malloc() function uses a similar concept to mempools.
 
 Concurrent Access to the Same Memory Area
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Signature · 1 line
2.51.0
#118 lore raw

Re: [PATCH v5 00/54] doc: programmers guide corrections

In reply to Stephen Hemminger
Quoted 47 lines

Stephen Hemminger (54):
doc: correct grammar and typos in argparse library guide
doc: correct grammar in service cores guide
doc: correct grammar and errors in trace library guide
doc: correct typos in log library guide
doc: correct errors in command-line library guide
doc: correct errors in trace library guide
doc: correct errors in stack library guide
doc: correct errors in RCU library guide
doc: correct grammar and formatting in ASan guide
doc: correct grammar and typos in bbdev guide
doc: correct grammar and formatting in bpf lib guide
doc: correct grammar and typos in meson build guide
doc: correct grammar and typos in cryptodev guide
doc: correct grammar and formatting in compressdev guide
doc: correct grammar in dmadev guide
doc: correct grammar in efd guide
doc: correct grammar in EAL guide
doc: correct double space in FIB guide
doc: correct grammar in GRO guide
doc: correct grammar in GSO guide
doc: correct typos and grammar in graph guide
doc: correct grammar in hash guide
doc: correct grammar and typos in IP fragment guide
doc: correct double spaces in IPsec guide
doc: correct grammar in lcore variables guide
doc: correct typo in link bonding guide
doc: correct grammar in LTO guide
doc: correct grammar in LPM guide
doc: correct grammar and typo in LPM6 guide
doc: correct grammar in introduction
doc: correct grammar in mbuf library guide
doc: correct grammar in membership library guide
doc: correct errors in mempool library guide
doc: correct style in meson unit tests guide
doc: correct errors in metrics library guide
doc: correct grammar in mldev library guide
doc: correct grammar in multi-process guide
doc: correct grammar in overview
doc: correct grammar in ACL library guide
doc: correct typos in packet distributor guide
doc: correct grammar in packet framework guide
doc: correct grammar in PDCP library guide
doc: correct grammar in pdump library guide
doc: correct typos in power management guide
doc: correct grammar in profiling guide
doc: correct errors in regexdev guide

Quoted 8 lines

doc: correct grammar in reorder library guide
doc: correct whitespace in RIB library guide
doc: correct incomplete sentence in ring library guide
doc: correct grammar in security library guide
doc: correct hyphenation in thread safety guide
doc: correct errors in toeplitz hash library guide
doc: correct errors in vhost library guide
doc: correct whitespace in efficient code guide

Applied, thanks.