DPDK patches and discussions
 help / color / mirror / Atom feed
From: Ferruh Yigit <ferruh.yigit@intel.com>
To: Ajit Khaparde <ajit.khaparde@broadcom.com>
Cc: dpdk-dev <dev@dpdk.org>,
	"Kovacevic, Marko" <marko.kovacevic@intel.com>,
	JP Lee <jongpil.lee@broadcom.com>,
	John McNamara <john.mcnamara@intel.com>
Subject: Re: [dpdk-dev] [PATCH] doc: update bnxt guide
Date: Wed, 13 May 2020 10:08:54 +0100	[thread overview]
Message-ID: <b88ba125-f502-0508-c6a3-f77877442238@intel.com> (raw)
In-Reply-To: <CACZ4nhs0XA6+b9OdZ1k+_aC57dPqFD95A73KSELQ==OKhesChA@mail.gmail.com>

On 5/6/2020 5:09 PM, Ajit Khaparde wrote:
> 
> 
> On Wed, May 6, 2020 at 1:57 AM Ferruh Yigit <ferruh.yigit@intel.com
> <mailto:ferruh.yigit@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@broadcom.com
>     <mailto:jongpil.lee@broadcom.com>>
>     > Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com
>     <mailto:ajit.khaparde@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.
> 

There was no doc review, unfortunately. At least can you send a new version by
keeping the line length around ~80. And I suggest if there is not other change
in the text, keep the original line length.


  reply	other threads:[~2020-05-13  9:09 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-01 22:03 Ajit Khaparde
2020-05-05 16:58 ` Ajit Khaparde
2020-05-06  8:57 ` Ferruh Yigit
2020-05-06 16:09   ` Ajit Khaparde
2020-05-13  9:08     ` Ferruh Yigit [this message]
2020-05-14 10:39 ` Kovacevic, Marko
2020-05-15 21:56   ` [dpdk-dev] [PATCH v2] " Ajit Khaparde
2020-05-18  9:34     ` Ferruh Yigit
2020-05-18 17:38       ` [dpdk-dev] [PATCH v3] " Ajit Khaparde
2020-05-18 17:58       ` [dpdk-dev] [PATCH v4] " Ajit Khaparde
2020-05-18 22:04         ` Ajit Khaparde
2020-05-19  8:15           ` Ferruh Yigit
2020-05-20 20:03             ` [dpdk-dev] [PATCH v5] " Ajit Khaparde
2020-05-21  1:16               ` Ajit Khaparde
2020-05-21 13:51                 ` Ferruh Yigit
2020-05-23  3:53                   ` Ajit Khaparde

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=b88ba125-f502-0508-c6a3-f77877442238@intel.com \
    --to=ferruh.yigit@intel.com \
    --cc=ajit.khaparde@broadcom.com \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=jongpil.lee@broadcom.com \
    --cc=marko.kovacevic@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).