diff mbox

[dpdk-dev,v2,04/15] bnxt: Update Broadcom PMD driver documentation

Message ID 20160926161837.GA28155@C02PT1RBG8WP.aus.broadcom.com (mailing list archive)
State Accepted, archived
Delegated to: Bruce Richardson
Headers

Commit Message

Ajit Khaparde Sept. 26, 2016, 4:18 p.m. UTC 
  Update doc/guides/nics/bnxt.rst to indicate that the bnxt PMD driver
supports Broadcom NetXtreme-C/NetXtreme-E BCM5730X/BCM5740X family of
network controllers and Broadcom StrataGX BCM5871X family of
communications processors.

Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
---
 doc/guides/nics/bnxt.rst | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

Comments

John McNamara Sept. 26, 2016, 7:33 p.m. UTC | #1 
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Ajit Khaparde
> Sent: Monday, September 26, 2016 5:19 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [v2 04/15] bnxt: Update Broadcom PMD driver
> documentation
> 
> Update doc/guides/nics/bnxt.rst to indicate that the bnxt PMD driver
> supports Broadcom NetXtreme-C/NetXtreme-E BCM5730X/BCM5740X family of
> network controllers and Broadcom StrataGX BCM5871X family of
> communications processors.
> 
> Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> ---
>  doc/guides/nics/bnxt.rst | 23 +++++++++++++++++------
>  1 file changed, 17 insertions(+), 6 deletions(-)
> 
> diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst index
> 2669e98..cf7fca8 100644
> --- a/doc/guides/nics/bnxt.rst
> +++ b/doc/guides/nics/bnxt.rst
> @@ -30,13 +30,24 @@
>  bnxt poll mode driver library
>  =============================
> 
> -The bnxt poll mode library (**librte_pmd_bnxt**) implements support for -
> **Broadcom NetXtreme(r) C-Series**.  These adapters support Standards- -
> compliant 10/25/50Gbps 30MPPS full-duplex throughput.
> -
> -Information about this family of adapters can be found in the
> +The bnxt poll mode library (**librte_pmd_bnxt**) implements support for:
> +**Broadcom NetXtreme-C(r)/NetXtreme-E(r) BCM5730X and BCM5740X family of
> +Ethernet Network Controllers**.  These adapters support Standards
> +compliant 10/25/50Gbps 30MPPS full-duplex throughput.
> +**Broadcom StrataGX(r) BCM5871X Series of Communucations Processors**
> +These ARM based processors target a broad range of networking
> +applications including virtual CPE (vCPE) and NFV appliances, 10G
> +service routers and gateways, control plane processing for Ethernet
> +switches and network attached storage (NAS).
> +
> +Information about the NetXtreme family of adapters can be found in the
>  `NetXtreme(r) Brand section <https://www.broadcom.com/products/ethernet-
> communication-and-switching?technology%5B%5D=88>`_
> -of the `Broadcom web site <http://www.broadcom.com/>`_.
> +of the `Broadcom website <http://www.broadcom.com/>`_.
> +
> +Information about the StrataGX family of adapters can be found in the
> +`StrataGX(r) BCM5871X Series section
> +<http://www.broadcom.com/products/enterprise-and-network-processors/pro
> +cessors/bcm58712>`_ of the `Broadcom website
> +<http://www.broadcom.com/>`_.

Hi,

There is a full stop missing before "These ARM ...".

Reformatting the text as follows would looks better in the rendered output:


The bnxt poll mode library (**librte_pmd_bnxt**) implements support for:

* **Broadcom NetXtreme-C(r)/NetXtreme-E(r) BCM5730X and BCM5740X family of
  Ethernet Network Controllers**: These adapters support Standards compliant
  10/25/50Gbps 30MPPS full-duplex throughput.

  Information about the NetXtreme family of adapters can be found in the
  `NetXtreme(r) Brand section
  <https://www.broadcom.com/products/ethernet-communication-and-switching?technology%5B%5D=88>`_
  of the `Broadcom website <http://www.broadcom.com/>`_.
  
* **Broadcom StrataGX(r) BCM5871X Series of Communucations Processors**: These
  ARM based processors target a broad range of networking applications
  including virtual CPE (vCPE) and NFV appliances, 10G service routers and
  gateways, control plane processing for Ethernet switches and network
  attached storage (NAS).

  Information about the StrataGX family of adapters can be found in the
  `StrataGX(r) BCM5871X Series section
  <http://www.broadcom.com/products/enterprise-and-network-processors/processors/bcm58712>`_
  of the `Broadcom website <http://www.broadcom.com/>`_.

P.S. Could you mark the V1 version as "superseded" in PatchWork.

Regards,

John
Ajit Khaparde Sept. 26, 2016, 7:39 p.m. UTC | #2 
On Mon, Sep 26, 2016 at 2:33 PM, Mcnamara, John <john.mcnamara@intel.com>
wrote:

> > -----Original Message-----
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Ajit Khaparde
> > Sent: Monday, September 26, 2016 5:19 PM
> > To: dev@dpdk.org
> > Subject: [dpdk-dev] [v2 04/15] bnxt: Update Broadcom PMD driver
> > documentation
> >
> > Update doc/guides/nics/bnxt.rst to indicate that the bnxt PMD driver
> > supports Broadcom NetXtreme-C/NetXtreme-E BCM5730X/BCM5740X family of
> > network controllers and Broadcom StrataGX BCM5871X family of
> > communications processors.
> >
> > Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> > ---
> >  doc/guides/nics/bnxt.rst | 23 +++++++++++++++++------
> >  1 file changed, 17 insertions(+), 6 deletions(-)
> >
> > diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst index
> > 2669e98..cf7fca8 100644
> > --- a/doc/guides/nics/bnxt.rst
> > +++ b/doc/guides/nics/bnxt.rst
> > @@ -30,13 +30,24 @@
> >  bnxt poll mode driver library
> >  =============================
> >
> > -The bnxt poll mode library (**librte_pmd_bnxt**) implements support for
> -
> > **Broadcom NetXtreme(r) C-Series**.  These adapters support Standards- -
> > compliant 10/25/50Gbps 30MPPS full-duplex throughput.
> > -
> > -Information about this family of adapters can be found in the
> > +The bnxt poll mode library (**librte_pmd_bnxt**) implements support for:
> > +**Broadcom NetXtreme-C(r)/NetXtreme-E(r) BCM5730X and BCM5740X family of
> > +Ethernet Network Controllers**.  These adapters support Standards
> > +compliant 10/25/50Gbps 30MPPS full-duplex throughput.
> > +**Broadcom StrataGX(r) BCM5871X Series of Communucations Processors**
> > +These ARM based processors target a broad range of networking
> > +applications including virtual CPE (vCPE) and NFV appliances, 10G
> > +service routers and gateways, control plane processing for Ethernet
> > +switches and network attached storage (NAS).
> > +
> > +Information about the NetXtreme family of adapters can be found in the
> >  `NetXtreme(r) Brand section <https://www.broadcom.com/
> products/ethernet-
> > communication-and-switching?technology%5B%5D=88>`_
> > -of the `Broadcom web site <http://www.broadcom.com/>`_.
> > +of the `Broadcom website <http://www.broadcom.com/>`_.
> > +
> > +Information about the StrataGX family of adapters can be found in the
> > +`StrataGX(r) BCM5871X Series section
> > +<http://www.broadcom.com/products/enterprise-and-network-processors/pro
> > +cessors/bcm58712>`_ of the `Broadcom website
> > +<http://www.broadcom.com/>`_.
>
> Hi,
>
> There is a full stop missing before "These ARM ...".
>
> Reformatting the text as follows would looks better in the rendered output:
>
​Do you want me to resend the patch (series).
Or you can manage it w/o that?
​


>
>
> The bnxt poll mode library (**librte_pmd_bnxt**) implements support for:
>
> * **Broadcom NetXtreme-C(r)/NetXtreme-E(r) BCM5730X and BCM5740X family of
>   Ethernet Network Controllers**: These adapters support Standards
> compliant
>   10/25/50Gbps 30MPPS full-duplex throughput.
>
>   Information about the NetXtreme family of adapters can be found in the
>   `NetXtreme(r) Brand section
>   <https://www.broadcom.com/products/ethernet-communication-and-switching?
> technology%5B%5D=88>`_
>   of the `Broadcom website <http://www.broadcom.com/>`_.
>
> * **Broadcom StrataGX(r) BCM5871X Series of Communucations Processors**:
> These
>   ARM based processors target a broad range of networking applications
>   including virtual CPE (vCPE) and NFV appliances, 10G service routers and
>   gateways, control plane processing for Ethernet switches and network
>   attached storage (NAS).
>
>   Information about the StrataGX family of adapters can be found in the
>   `StrataGX(r) BCM5871X Series section
>   <http://www.broadcom.com/products/enterprise-and-
> network-processors/processors/bcm58712>`_
>   of the `Broadcom website <http://www.broadcom.com/>`_.
>
> P.S. Could you mark the V1 version as "superseded" in PatchWork.
>
​Sure.
​


>
> Regards,
>
> John
>
John McNamara Sept. 26, 2016, 8:22 p.m. UTC | #3 
>> Reformatting the text as follows would looks better in the rendered output:

​
> Do you want me to resend the patch (series).

> Or you can manage it w/o that?


It isn't worth resubmitting the patchset for this. If you do have to resubmit for other reasons you can make these changes as well.

So:

Acked-by: John McNamara <john.mcnamara@intel.com>
diff mbox

Patch

diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst
index 2669e98..cf7fca8 100644
--- a/doc/guides/nics/bnxt.rst
+++ b/doc/guides/nics/bnxt.rst
@@ -30,13 +30,24 @@ 
 bnxt poll mode driver library
 =============================
 
-The bnxt poll mode library (**librte_pmd_bnxt**) implements support for
-**Broadcom NetXtreme® C-Series**.  These adapters support Standards-
-compliant 10/25/50Gbps 30MPPS full-duplex throughput.
-
-Information about this family of adapters can be found in the
+The bnxt poll mode library (**librte_pmd_bnxt**) implements support for:
+**Broadcom NetXtreme-C®/NetXtreme-E® BCM5730X and BCM5740X family of
+Ethernet Network Controllers**.  These adapters support Standards compliant
+10/25/50Gbps 30MPPS full-duplex throughput.
+**Broadcom StrataGX® BCM5871X Series of Communucations Processors**
+These ARM based processors target a broad range of networking applications
+including virtual CPE (vCPE) and NFV appliances, 10G service routers and
+gateways, control plane processing for Ethernet switches and network attached
+storage (NAS).
+
+Information about the NetXtreme family of adapters can be found in the
 `NetXtreme® Brand section <https://www.broadcom.com/products/ethernet-communication-and-switching?technology%5B%5D=88>`_
-of the `Broadcom web site <http://www.broadcom.com/>`_.
+of the `Broadcom website <http://www.broadcom.com/>`_.
+
+Information about the StrataGX family of adapters can be found in the
+`StrataGX® BCM5871X Series section
+<http://www.broadcom.com/products/enterprise-and-network-processors/processors/bcm58712>`_
+of the `Broadcom website <http://www.broadcom.com/>`_.
 
 Limitations
 -----------