From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>,
Chas Williams <chas3@att.com>,
"Min Hu (Connor)" <humin29@huawei.com>,
Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>,
Luca Boccassi <bluca@debian.org>, Rosen Xu <rosen.xu@intel.com>
Subject: [dpdk-dev] [PATCH 8/8] doc: fix driver names in programmers guide
Date: Mon, 2 Nov 2020 17:45:07 +0000 [thread overview]
Message-ID: <20201102174507.1085128-9-bruce.richardson@intel.com> (raw)
In-Reply-To: <20201102174507.1085128-1-bruce.richardson@intel.com>
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(-)
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::
--
2.25.1
next prev parent reply other threads:[~2020-11-02 17:47 UTC|newest]
Thread overview: 39+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-02 17:44 [dpdk-dev] [PATCH 0/8] fix driver filenames in the docs Bruce Richardson
2020-11-02 17:45 ` [dpdk-dev] [PATCH 1/8] regex/octeontx2: fix unnecessary name override Bruce Richardson
2020-11-02 19:48 ` David Marchand
2020-11-03 0:30 ` Thomas Monjalon
2020-11-03 8:19 ` David Marchand
2020-11-03 9:06 ` Thomas Monjalon
2020-11-03 9:19 ` David Marchand
2020-11-03 9:45 ` David Marchand
2020-11-03 10:27 ` Bruce Richardson
2020-11-02 17:45 ` [dpdk-dev] [PATCH 2/8] doc: fix driver names in compression devices guide Bruce Richardson
2020-11-02 19:54 ` David Marchand
2020-11-02 17:45 ` [dpdk-dev] [PATCH 3/8] doc: fix driver names in crypto " Bruce Richardson
2020-11-02 20:00 ` David Marchand
2020-11-02 20:02 ` David Marchand
2020-11-03 10:28 ` Bruce Richardson
2020-11-02 17:45 ` [dpdk-dev] [PATCH 4/8] doc: fix driver names in event " Bruce Richardson
2020-11-02 20:03 ` David Marchand
2020-11-02 17:45 ` [dpdk-dev] [PATCH 5/8] doc: fix driver names in NIC " Bruce Richardson
2020-11-02 20:17 ` David Marchand
2020-11-02 20:45 ` David Marchand
2020-11-03 2:31 ` Xu, Rosen
2020-11-03 2:47 ` Ajit Khaparde
2020-11-02 17:45 ` [dpdk-dev] [PATCH 6/8] doc: fix driver names in regex " Bruce Richardson
2020-11-02 20:07 ` David Marchand
2020-11-02 17:45 ` [dpdk-dev] [PATCH 7/8] doc: fix driver names in vDPA " Bruce Richardson
2020-11-02 20:09 ` David Marchand
2020-11-02 17:45 ` Bruce Richardson [this message]
2020-11-02 20:12 ` [dpdk-dev] [PATCH 8/8] doc: fix driver names in programmers guide David Marchand
2020-11-02 20:19 ` [dpdk-dev] [PATCH 0/8] fix driver filenames in the docs David Marchand
2020-11-03 12:36 ` [dpdk-dev] [PATCH v2 0/7] " Bruce Richardson
2020-11-03 12:36 ` [dpdk-dev] [PATCH v2 1/7] doc: fix driver names in compression devices guide Bruce Richardson
2020-11-03 12:36 ` [dpdk-dev] [PATCH v2 2/7] doc: fix driver names in crypto " Bruce Richardson
2020-11-03 13:05 ` David Marchand
2020-11-03 12:36 ` [dpdk-dev] [PATCH v2 3/7] doc: fix driver names in event " Bruce Richardson
2020-11-03 12:36 ` [dpdk-dev] [PATCH v2 4/7] doc: fix driver names in NIC " Bruce Richardson
2020-11-03 12:36 ` [dpdk-dev] [PATCH v2 5/7] doc: fix driver names in regex " Bruce Richardson
2020-11-03 12:36 ` [dpdk-dev] [PATCH v2 6/7] doc: fix driver names in vDPA " Bruce Richardson
2020-11-03 12:36 ` [dpdk-dev] [PATCH v2 7/7] doc: fix driver names in programmers guide Bruce Richardson
2020-11-03 14:50 ` [dpdk-dev] [PATCH v2 0/7] fix driver filenames in the docs David Marchand
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=20201102174507.1085128-9-bruce.richardson@intel.com \
--to=bruce.richardson@intel.com \
--cc=andrew.rybchenko@oktetlabs.ru \
--cc=bluca@debian.org \
--cc=chas3@att.com \
--cc=dev@dpdk.org \
--cc=humin29@huawei.com \
--cc=rosen.xu@intel.com \
/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).