[dpdk-dev] [PATCH] doc: fix link bonding pmd typo in prog guide

[dpdk-dev] [PATCH] doc: fix link bonding pmd typo in prog guide

[Zhiyong Yang]

fix one typo and a grammatical mistake.

Fixes: b0152b1b40fe("doc: update bonding")
Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
---
 doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 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 1ef231df9..244424269 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
@@ -33,7 +33,7 @@ Link Bonding Poll Mode Driver Library
 
 In addition to Poll Mode Drivers (PMDs) for physical and virtual hardware,
 DPDK also includes a pure-software library that
-allows physical PMD's to be bonded together to create a single logical PMD.
+allows physical PMDs to be bonded together to create a single logical PMD.
 
 .. figure:: img/bond-overview.*
 
@@ -42,7 +42,7 @@ allows physical PMD's to be bonded together to create a single logical PMD.
 
 The Link Bonding PMD library(librte_pmd_bond) supports bonding of groups of
 ``rte_eth_dev`` ports of the same speed and duplex to provide
-similar the capabilities to that found in Linux bonding driver to allow the
+the capabilities similar to that found in Linux bonding driver to allow the
 aggregation of multiple (slave) NICs into a single logical interface between a
 server 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
-- 
2.13.3

Re: [dpdk-dev] [PATCH] doc: fix link bonding pmd typo in prog guide

[Kovacevic, Marko]

> fix one typo and a grammatical mistake.
> 
> Fixes: b0152b1b40fe("doc: update bonding")
> Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>

First thing the git check log spit this error out so can you please just make these changes

Running git check log on HEAD~1:  32787
 ======================================
Wrong headline lowercase:
   doc: fix link bonding pmd typo in prog guide Wrong tag:
                                         ^^^^
Upper case                     PMD

    Fixes: b0152b1b40fe("doc: update bonding") Wrong 'Fixes' reference:
    Fixes: b0152b1b40fe("doc: update bonding")
		          ^^	
Insert a space..... Fixes: b0152b1b40fe ("doc: update bonding")
                                                                
 Is it candidate for Cc:  stable@dpdk.org backport? 
If it is Cc: the stable mailing list in the commit message body

I don't think this is really an error but put a space between Fixes
And Signed -off-by

> Fixes: b0152b1b40fe("doc: update bonding")
> Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>


<...>

> 
>  The Link Bonding PMD library(librte_pmd_bond) supports bonding of groups of
> ``rte_eth_dev`` ports of the same speed and duplex to 
>  provide -similar the capabilities to that found in Linux bonding driver to allow the
    ^^^^^^^^^^^^^^^^^^^^^^^^^^
"to provide the similar capabilities" sounds better to me

> +the capabilities similar to that found in Linux bonding driver to allow
> +the
>  aggregation of multiple (slave) NICs into a single logical interface between a
> server 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

Once this has been changed you can include my Ack in the next version of the patch.

Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>

Re: [dpdk-dev] [PATCH] doc: fix link bonding pmd typo in prog guide

[Yang, Zhiyong]

Thanks Marko, 
Fix the issues according to your comments.
V2 has been sent out.

Thanks
Zhiyong

> -----Original Message-----
> From: Kovacevic, Marko
> Sent: Friday, January 12, 2018 5:37 PM
> To: Yang, Zhiyong <zhiyong.yang@intel.com>; dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>
> Subject: RE: [dpdk-dev] [PATCH] doc: fix link bonding pmd typo in prog guide
> 
> > fix one typo and a grammatical mistake.
> >
> > Fixes: b0152b1b40fe("doc: update bonding")
> > Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
> 
> First thing the git check log spit this error out so can you please just make
> these changes
> 
> Running git check log on HEAD~1:  32787
>  ======================================
> Wrong headline lowercase:
>    doc: fix link bonding pmd typo in prog guide Wrong tag:
>                                          ^^^^
> Upper case                     PMD
> 
>     Fixes: b0152b1b40fe("doc: update bonding") Wrong 'Fixes' reference:
>     Fixes: b0152b1b40fe("doc: update bonding")
> 		          ^^
> Insert a space..... Fixes: b0152b1b40fe ("doc: update bonding")
> 
>  Is it candidate for Cc:  stable@dpdk.org backport?
> If it is Cc: the stable mailing list in the commit message body
> 
> I don't think this is really an error but put a space between Fixes And Signed -
> off-by
> 
> > Fixes: b0152b1b40fe("doc: update bonding")
> > Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
> 
> 
> <...>
> 
> >
> >  The Link Bonding PMD library(librte_pmd_bond) supports bonding of
> > groups of ``rte_eth_dev`` ports of the same speed and duplex to
> > provide -similar the capabilities to that found in Linux bonding
> > driver to allow the
>     ^^^^^^^^^^^^^^^^^^^^^^^^^^
> "to provide the similar capabilities" sounds better to me
> 
> > +the capabilities similar to that found in Linux bonding driver to
> > +allow the
> >  aggregation of multiple (slave) NICs into a single logical interface
> > between a server 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
> 
> Once this has been changed you can include my Ack in the next version of
> the patch.
> 
> Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>

Re: [dpdk-dev] [PATCH] doc: fix link bonding pmd typo in prog guide

[Kovacevic, Marko]

Actually just one more change it would be better as "similar capabilities" instead of "the similar capabilities"

The Link Bonding PMD library(librte_pmd_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 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

Marko K.

Re: [dpdk-dev] [PATCH] doc: fix link bonding pmd typo in prog guide

[Yang, Zhiyong]

Thanks, V3 will be coming soon.

> -----Original Message-----
> From: Kovacevic, Marko
> Sent: Monday, January 15, 2018 7:22 PM
> To: Yang, Zhiyong <zhiyong.yang@intel.com>; dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>
> Subject: RE: [dpdk-dev] [PATCH] doc: fix link bonding pmd typo in prog guide
> 
> Actually just one more change it would be better as "similar capabilities"
> instead of "the similar capabilities"
> 
> The Link Bonding PMD library(librte_pmd_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 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
> 
> Marko K.

[dpdk-dev] [PATCH v2] doc: fix link bonding PMD typo in prog guide

[Zhiyong Yang]

fix one typo and a grammatical mistake.

Fixes: b0152b1b40fe ("doc: update bonding")
Cc: stable@dpdk.org

Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
---

Changes in V2:
1. Fix the title and fixline format issue in commit log.

 doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 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 1ef231df9..6bb299f99 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
@@ -33,7 +33,7 @@ Link Bonding Poll Mode Driver Library
 
 In addition to Poll Mode Drivers (PMDs) for physical and virtual hardware,
 DPDK also includes a pure-software library that
-allows physical PMD's to be bonded together to create a single logical PMD.
+allows physical PMDs to be bonded together to create a single logical PMD.
 
 .. figure:: img/bond-overview.*
 
@@ -42,7 +42,7 @@ allows physical PMD's to be bonded together to create a single logical PMD.
 
 The Link Bonding PMD library(librte_pmd_bond) supports bonding of groups of
 ``rte_eth_dev`` ports of the same speed and duplex to provide
-similar the capabilities to that found in Linux bonding driver to allow the
+the 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 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
-- 
2.13.3

Re: [dpdk-dev] [PATCH v2] doc: fix link bonding PMD typo in prog guide

[Kovacevic, Marko]

Actually just one more change it would be better as "similar capabilities" instead
 of "the similar capabilities"
 
 The Link Bonding PMD library(librte_pmd_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 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
 
 Marko K.

[dpdk-dev] [PATCH v3] doc: fix link bonding PMD typo in prog guide

[Zhiyong Yang]

fix one typo and a grammatical mistake.

Fixes: b0152b1b40fe ("doc: update bonding")
Cc: stable@dpdk.org

Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
---

Changes in V3:
use "similar capabilities" instead of "the similar capabilities"

Changes in V2:
Fix the title and fixline format issue in commit log.

 doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 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 1ef231df9..e13a54fc5 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
@@ -33,7 +33,7 @@ Link Bonding Poll Mode Driver Library
 
 In addition to Poll Mode Drivers (PMDs) for physical and virtual hardware,
 DPDK also includes a pure-software library that
-allows physical PMD's to be bonded together to create a single logical PMD.
+allows physical PMDs to be bonded together to create a single logical PMD.
 
 .. figure:: img/bond-overview.*
 
@@ -41,12 +41,12 @@ allows physical PMD's to be bonded together to create a single logical PMD.
 
 
 The Link Bonding PMD library(librte_pmd_bond) supports bonding of groups of
-``rte_eth_dev`` ports of the same speed and duplex to provide
-similar the capabilities to that found in Linux bonding driver to allow the
-aggregation of multiple (slave) NICs into a single logical interface between a
-server 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.
+``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
+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
 creation of bonded devices as well as the configuration and management of the
-- 
2.13.3

Re: [dpdk-dev] [dpdk-stable] [PATCH v3] doc: fix link bonding PMD typo in prog guide

[Ferruh Yigit]

On 1/19/2018 2:21 AM, Zhiyong Yang wrote:
> fix one typo and a grammatical mistake.
> 
> Fixes: b0152b1b40fe ("doc: update bonding")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
> Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>

Applied to dpdk-next-net/master, thanks.