diff mbox series

[ovs-dev,ovn] Fix small wording error in README

Message ID 20200508062855.380988-1-numans@ovn.org
State Accepted
Headers show
Series [ovs-dev,ovn] Fix small wording error in README | expand

Commit Message

Numan Siddique May 8, 2020, 6:28 a.m. UTC
From: Ryan Goulding <rgouldin@redhat.com>

Fixes a small wording error in README.rst, and reformats following lines to
adhere to a max length of 80 characters in the given context.

Submitted-at: https://github.com/ovn-org/ovn/pull/41
Signed-off-by: Ryan Goulding <rgouldin@redhat.com>
Signed-off-by: Numan Siddique <numans@ovn.org>
---
 AUTHORS.rst | 1 +
 README.rst  | 9 ++++-----
 2 files changed, 5 insertions(+), 5 deletions(-)

Comments

Numan Siddique May 8, 2020, 6:35 a.m. UTC | #1
On Fri, May 8, 2020 at 11:59 AM <numans@ovn.org> wrote:

> From: Ryan Goulding <rgouldin@redhat.com>
>
> Fixes a small wording error in README.rst, and reformats following lines to
> adhere to a max length of 80 characters in the given context.
>
> Submitted-at: https://github.com/ovn-org/ovn/pull/41
> Signed-off-by: Ryan Goulding <rgouldin@redhat.com>
> Signed-off-by: Numan Siddique <numans@ovn.org>
>

Thanks Ryan for the PR. I applied this patch to master.

Thanks
Numan


> ---
>  AUTHORS.rst | 1 +
>  README.rst  | 9 ++++-----
>  2 files changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/AUTHORS.rst b/AUTHORS.rst
> index 77f35ada9..b307a9359 100644
> --- a/AUTHORS.rst
> +++ b/AUTHORS.rst
> @@ -317,6 +317,7 @@ Romain Lenglet
> romain.lenglet@berabera.info
>  Roni Bar Yanai                     roniba@mellanox.com
>  Russell Bryant                     russell@ovn.org
>  RYAN D. MOATS                      rmoats@us.ibm.com
> +Ryan Goulding                      rgouldin@redhat.com
>  Ryan Wilson
>  Sairam Venugopal                   vsairam@vmware.com
>  Sajjad Lateef
> diff --git a/README.rst b/README.rst
> index d6f148181..07174ba57 100644
> --- a/README.rst
> +++ b/README.rst
> @@ -12,11 +12,10 @@ OVN (Open Virtual Network) is a series of daemons that
> translates virtual
>  network configuration into OpenFlow, and installs them into Open vSwitch.
>  It is licensed under the open source Apache 2 license.
>
> -OVN is provides a higher-layer abstraction then Open vSwitch, working with
> -logical routers and logical switches, rather than flows. OVN is intended
> to be
> -used by cloud management software (CMS). For details about the
> architecture of
> -OVN, see the ovn-architecture manpage. Some high-level features offered
> by OVN
> -include
> +OVN provides a higher-layer abstraction then Open vSwitch, working with
> logical
> +routers and logical switches, rather than flows. OVN is intended to be
> used by
> +cloud management software (CMS). For details about the architecture of
> OVN, see
> +the ovn-architecture manpage. Some high-level features offered by OVN
> include:
>
>  * Distributed virtual routers
>  * Distributed logical switches
> --
> 2.26.2
>
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>
>
0-day Robot May 8, 2020, 7:04 a.m. UTC | #2
Bleep bloop.  Greetings Numan Siddique, I am a robot and I have tried out your patch.
Thanks for your contribution.

I encountered some error that I wasn't expecting.  See the details below.


checkpatch:
WARNING: Line is 81 characters long (recommended limit is 79)
#157 FILE: Documentation/index.rst:33:
The Open Virtual Network (OVN) documentation is organised into multiple sections:

WARNING: Line is 89 characters long (recommended limit is 79)
#171 FILE: Documentation/index.rst:75:
Learn more about the Open Virtual Network (OVN) project and about how you can contribute:

WARNING: Line is 81 characters long (recommended limit is 79)
#315 FILE: Documentation/topics/index.rst:50:
     - `(plain text) <http://ovn.org/support/dist-docs/ovn-architecture.7.txt>`__

Lines checked: 344, Warnings: 3, Errors: 0


Please check this out.  If you feel there has been an error, please email aconole@redhat.com

Thanks,
0-day Robot
diff mbox series

Patch

diff --git a/AUTHORS.rst b/AUTHORS.rst
index 77f35ada9..b307a9359 100644
--- a/AUTHORS.rst
+++ b/AUTHORS.rst
@@ -317,6 +317,7 @@  Romain Lenglet                     romain.lenglet@berabera.info
 Roni Bar Yanai                     roniba@mellanox.com
 Russell Bryant                     russell@ovn.org
 RYAN D. MOATS                      rmoats@us.ibm.com
+Ryan Goulding                      rgouldin@redhat.com
 Ryan Wilson
 Sairam Venugopal                   vsairam@vmware.com
 Sajjad Lateef
diff --git a/README.rst b/README.rst
index d6f148181..07174ba57 100644
--- a/README.rst
+++ b/README.rst
@@ -12,11 +12,10 @@  OVN (Open Virtual Network) is a series of daemons that translates virtual
 network configuration into OpenFlow, and installs them into Open vSwitch.
 It is licensed under the open source Apache 2 license.
 
-OVN is provides a higher-layer abstraction then Open vSwitch, working with
-logical routers and logical switches, rather than flows. OVN is intended to be
-used by cloud management software (CMS). For details about the architecture of
-OVN, see the ovn-architecture manpage. Some high-level features offered by OVN
-include
+OVN provides a higher-layer abstraction then Open vSwitch, working with logical
+routers and logical switches, rather than flows. OVN is intended to be used by
+cloud management software (CMS). For details about the architecture of OVN, see
+the ovn-architecture manpage. Some high-level features offered by OVN include:
 
 * Distributed virtual routers
 * Distributed logical switches