From patchwork Mon Nov 2 17:45:07 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 83432 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 6C785A04E7; Mon, 2 Nov 2020 18:47:55 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 519162B93; Mon, 2 Nov 2020 18:46:22 +0100 (CET) Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id BA15E160 for ; Mon, 2 Nov 2020 18:46:19 +0100 (CET) IronPort-SDR: 7KM+q7SkMYWeTmETJaokMPoyu/INeiPGJsrvjqRMyUIUHDQKmbqeLtpDRVnVyhVTXsiCA845Xd bVVP6xDgJb4g== X-IronPort-AV: E=McAfee;i="6000,8403,9793"; a="165419805" X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="165419805" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga102.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 02 Nov 2020 09:46:17 -0800 IronPort-SDR: O5C0WCkzhtOICxs95L/RchojLIDhwkyVKXTcixhqvLkPtk9PU3snKAjw+8UedR8jkvjhA7eP13 1h/D9bsYERIQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="336243739" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by orsmga002.jf.intel.com with ESMTP; 02 Nov 2020 09:46:15 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , Chas Williams , "Min Hu (Connor)" , Andrew Rybchenko , Luca Boccassi , Rosen Xu Date: Mon, 2 Nov 2020 17:45:07 +0000 Message-Id: <20201102174507.1085128-9-bruce.richardson@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201102174507.1085128-1-bruce.richardson@intel.com> References: <20201102174507.1085128-1-bruce.richardson@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH 8/8] doc: fix driver names in programmers guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 Reviewed-by: David Marchand --- .../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::