[dpdk-dev] [PATCH] doc: update bnxt guide

[Ajit Khaparde]

On Wed, May 6, 2020 at 1:57 AM Ferruh Yigit <ferruh.yigit at intel.com> wrote:

> On 5/1/2020 11:03 PM, Ajit Khaparde wrote:
> >     - Update list of supported adapters.
> >     - Update list of supported features.
> >     - Add some details to describe the features.
> >     - Remove obsolete limitations.
> >     - Fix and update links.
> >
> > Signed-off-by: JP Lee <jongpil.lee at broadcom.com>
> > Signed-off-by: Ajit Khaparde <ajit.khaparde at broadcom.com>
> > ---
> >  doc/guides/nics/bnxt.rst | 1131 +++++++++++++++++++++++++++++++++-----
> >  1 file changed, 1001 insertions(+), 130 deletions(-)
> >
> > diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst
> > index 434ba9d6c..0da312557 100644
> > --- a/doc/guides/nics/bnxt.rst
> > +++ b/doc/guides/nics/bnxt.rst
> > @@ -1,138 +1,1009 @@
> > -..  SPDX-License-Identifier: BSD-3-Clause
> > -    Copyright 2016-2019 Broadcom
> > +.. SPDX-License-Identifier: BSD-3-Clause
> > +   Copyright 2020 Broadcom Inc.
> >
> >  BNXT Poll Mode Driver
> >  =====================
> >
> > -The BNXT PMD (**librte_pmd_bnxt**) implements support for adapters
> based on
> > -Ethernet controllers and SoCs belonging to the **Broadcom BCM5730X
> NetXtreme-C®
> > -Family of Ethernet Network Controllers**, the **Broadcom
> BCM574XX/BCM575XX
> > -NetXtreme-E® Family of Ethernet Network Controllers**, the **Broadcom
> BCM588XX
> > -Stingray Family of SmartNIC Adapters**, and the **Broadcom StrataGX®
> BCM5871X
> > -Series of Communications Processors**.  A complete list with links to
> reference
> > -material is included below.
> > +The Broadcom BNXT PMD (Poll Mode Driver, librte_pmd_bnxt) implements
> support for adapters based on Ethernet controllers and SoCs belonging to
> the Broadcom BCM574XX/BCM575XX NetXtreme-E® Family of Ethernet Network
> Controllers, the Broadcom BCM588XX Stingray Family of Smart NIC Adapters,
> and the Broadcom StrataGX® BCM5873X Series of Communications Processors.
>
> Hi Ajit,
>
> This adds single line with 358 char length, most probably the web output
> is good
> but it is hard to read/maintain as .rst doc.
>
> What is the motivation for joining the multiple lines?
>
No specific reason. Mostly an oversight. We can fix it if necessary.


>
> For the content we need your ack, but for the style/formatting/language
> etc..
> would you mind waiting for an ack from doc maintainers, cc'ed, before
> merge?
>
Sure. Not an issue.

Thanks

>
> Thanks,
> ferruh
>