diff options
author | Justin Pettit <jpettit@ovn.org> | 2018-03-14 14:38:38 -0700 |
---|---|---|
committer | Justin Pettit <jpettit@ovn.org> | 2018-03-14 16:29:34 -0700 |
commit | dfec5030fc7ccfa579a4c34ab57ba98e55f96632 (patch) | |
tree | cb94c52d3361ed3a714798f1b30c913e7905f688 /Documentation/internals | |
parent | 771c8ea048236155c8f258d4cff80a09127711ab (diff) | |
download | openvswitch-dfec5030fc7ccfa579a4c34ab57ba98e55f96632.tar.gz |
Clean up some minor spelling and typos.
Signed-off-by: Justin Pettit <jpettit@ovn.org>
Acked-by: Ben Pfaff <blp@ovn.org>
Diffstat (limited to 'Documentation/internals')
5 files changed, 11 insertions, 11 deletions
diff --git a/Documentation/internals/committer-responsibilities.rst b/Documentation/internals/committer-responsibilities.rst index 954daa8a9..4d10c3980 100644 --- a/Documentation/internals/committer-responsibilities.rst +++ b/Documentation/internals/committer-responsibilities.rst @@ -28,7 +28,7 @@ Expectations for Developers with Open vSwitch Repo Access Pre-requisites -------------- -Be familar with the guidlines and standards defined in +Be familiar with the guidelines and standards defined in :doc:`contributing/index`. Review diff --git a/Documentation/internals/contributing/backporting-patches.rst b/Documentation/internals/contributing/backporting-patches.rst index 30624277a..e8f4f271c 100644 --- a/Documentation/internals/contributing/backporting-patches.rst +++ b/Documentation/internals/contributing/backporting-patches.rst @@ -83,7 +83,7 @@ patch, for example: If a maintainer is backporting a change to older branches and the backport is not a trivial cherry-pick, then the maintainer may opt to submit the backport -for the older branch on the mailinglist for further review. This should be done +for the older branch on the mailing list for further review. This should be done in the same manner as described above. Changes to Linux kernel components diff --git a/Documentation/internals/contributing/coding-style-windows.rst b/Documentation/internals/contributing/coding-style-windows.rst index 9bd7f0563..1edf2285f 100644 --- a/Documentation/internals/contributing/coding-style-windows.rst +++ b/Documentation/internals/contributing/coding-style-windows.rst @@ -25,14 +25,14 @@ Open vSwitch Windows Datapath Coding Style ========================================== -The :doc:`coding style <coding-style>` guide gives the flexiblity for each +The :doc:`coding style <coding-style>` guide gives the flexibility for each platform to use its own coding style for the kernel datapath. This file describes the specific coding style used in most of the C files in the Windows kernel datapath of the Open vSwitch distribution. Most of the coding conventions applicable for the Open vSwitch distribution are applicable to the Windows kernel datapath as well. There are some exceptions -and new guidlines owing to the commonly followed practices in Windows +and new guidelines owing to the commonly followed practices in Windows kernel/driver code. They are noted as follows: Basics @@ -61,7 +61,7 @@ Naming It is common practice to use camel casing for naming variables, functions and files in Windows. For types, especially structures, unions and enums, using -all upper case letters with words seprated by '_' is common. These practices +all upper case letters with words separated by '_' is common. These practices can be used for OVS Windows datapath. However, use the following guidelines: - Use lower case to begin the name of a variable. @@ -119,7 +119,7 @@ Comments -------- Comments should be written as full sentences that start with a capital letter -and end with a period. Putting two spaces between sentances is not necessary. +and end with a period. Putting two spaces between sentences is not necessary. ``//`` can be used for comments as long as the comment is a single line comment. For block comments, use ``/* */`` comments diff --git a/Documentation/internals/contributing/documentation-style.rst b/Documentation/internals/contributing/documentation-style.rst index 0e561ec23..9c47bd61f 100644 --- a/Documentation/internals/contributing/documentation-style.rst +++ b/Documentation/internals/contributing/documentation-style.rst @@ -411,7 +411,7 @@ vSwitch documentation. These guidelines are based on the `IBM Style Guide * - To create a bridge, the user runs: - To create a bridge, run: -- Keep sentences short and consise +- Keep sentences short and concise - Eliminate needless politeness diff --git a/Documentation/internals/contributing/submitting-patches.rst b/Documentation/internals/contributing/submitting-patches.rst index eb7e651b8..0ddd24502 100644 --- a/Documentation/internals/contributing/submitting-patches.rst +++ b/Documentation/internals/contributing/submitting-patches.rst @@ -95,7 +95,7 @@ Where: ``<summary>``: - briefly describes the change. Use the the imperative form, + briefly describes the change. Use the imperative form, e.g. "Force SNAT for multiple gateway routers." or "Fix daemon exit for bad datapaths or flows." Try to keep the summary short, about 50 characters wide. @@ -318,7 +318,7 @@ Developer's Certificate of Origin To help track the author of a patch as well as the submission chain, and be clear that the developer has authority to submit a patch for inclusion in -openvswitch please sign off your work. The sign off certifies the following: +Open vSwitch please sign off your work. The sign off certifies the following: :: @@ -411,9 +411,9 @@ file describes the coding style used in most of Open vSwitch. Use Linux kernel coding style for Linux kernel code. If your code is non-datapath code, you may use the ``utilities/checkpatch.py`` -utility as a quick check for certain commonly occuring mistakes (improper +utility as a quick check for certain commonly occurring mistakes (improper leading/trailing whitespace, missing signoffs, some improper formatted patch -files). For linux datapath code, it is a good idea to use the linux script +files). For Linux datapath code, it is a good idea to use the Linux script ``checkpatch.pl``. Example |