diff mbox series

[8/8] doc: fix driver names in programmers guide

Message ID 20201102174507.1085128-9-bruce.richardson@intel.com (mailing list archive)
State Changes Requested, archived
Delegated to: David Marchand
Headers show
Series fix driver filenames in the docs | expand

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-testing fail Testing issues
ci/iol-broadcom-Functional success Functional Testing PASS
ci/checkpatch success coding style OK

Commit Message

Bruce Richardson Nov. 2, 2020, 5:45 p.m. UTC
Since the built driver filenames have changed in DPDK 20.11, we need to
update the programmers guide doc to match.

Fixes: a20b2c01a7a1 ("build: standardize component names and defines")

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 .../prog_guide/link_bonding_poll_mode_drv_lib.rst      | 10 +++++-----
 doc/guides/prog_guide/source_org.rst                   |  3 ++-
 2 files changed, 7 insertions(+), 6 deletions(-)

Comments

David Marchand Nov. 2, 2020, 8:12 p.m. UTC | #1
On Mon, Nov 2, 2020 at 6:48 PM Bruce Richardson
<bruce.richardson@intel.com> wrote:
>
> Since the built driver filenames have changed in DPDK 20.11, we need to
> update the programmers guide doc to match.
>
> Fixes: a20b2c01a7a1 ("build: standardize component names and defines")
>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Reviewed-by: David Marchand <david.marchand@redhat.com>
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst b/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst
index 244dca56c4..30c56cd375 100644
--- a/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst
+++ b/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst
@@ -13,7 +13,7 @@  allows physical PMDs to be bonded together to create a single logical PMD.
    Bonded PMDs
 
 
-The Link Bonding PMD library(librte_pmd_bond) supports bonding of groups of
+The Link Bonding PMD library(librte_net_bond) supports bonding of groups of
 ``rte_eth_dev`` ports of the same speed and duplex to provide similar
 capabilities to that found in Linux bonding driver to allow the aggregation
 of multiple (slave) NICs into a single logical interface between a server
@@ -21,7 +21,7 @@  and a switch. The new bonded PMD will then process these interfaces based on
 the mode of operation specified to provide support for features such as
 redundant links, fault tolerance and/or load balancing.
 
-The librte_pmd_bond library exports a C API which provides an API for the
+The librte_net_bond library exports a C API which provides an API for the
 creation of bonded devices as well as the configuration and management of the
 bonded device and its slave devices.
 
@@ -133,7 +133,7 @@  Currently the Link Bonding PMD library supports following modes of operation:
 Implementation Details
 ----------------------
 
-The librte_pmd_bond bonded device are compatible with the Ethernet device API
+The librte_net_bond bonded device are compatible with the Ethernet device API
 exported by the Ethernet PMDs described in the *DPDK API Reference*.
 
 The Link Bonding Library supports the creation of bonded devices at application
@@ -329,7 +329,7 @@  and UDP protocols for load balancing.
 Using Link Bonding Devices
 --------------------------
 
-The librte_pmd_bond library supports two modes of device creation, the libraries
+The librte_net_bond library supports two modes of device creation, the libraries
 export full C API or using the EAL command line to statically configure link
 bonding devices at application startup. Using the EAL option it is possible to
 use link bonding functionality transparently without specific knowledge of the
@@ -340,7 +340,7 @@  the link bonding C API.
 Using the Poll Mode Driver from an Application
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Using the librte_pmd_bond libraries API it is possible to dynamically create
+Using the librte_net_bond libraries API it is possible to dynamically create
 and manage link bonding device from within any application. Link bonding
 devices are created using the ``rte_eth_bond_create`` API which requires a
 unique device name, the link bonding mode to initial the device in and finally
diff --git a/doc/guides/prog_guide/source_org.rst b/doc/guides/prog_guide/source_org.rst
index 8d531bd9ef..5e4333460a 100644
--- a/doc/guides/prog_guide/source_org.rst
+++ b/doc/guides/prog_guide/source_org.rst
@@ -21,7 +21,8 @@  Drivers
 Drivers are special libraries which provide poll-mode driver implementations for
 devices: either hardware devices or pseudo/virtual devices. They are contained
 in the *drivers* subdirectory, classified by type, and each compiles to a
-library with the format ``librte_pmd_X.a`` where ``X`` is the driver name.
+library with the format ``librte_X_Y.a`` where ``X`` is the device class
+name and ``Y`` is the driver name.
 
 .. note::