[ovs-dev] [PATCH 01/15] doc: Convert CodingStyle to rST

Russell Bryant russell at ovn.org
Thu Oct 20 17:15:34 UTC 2016


On Tue, Oct 18, 2016 at 4:03 PM, Stephen Finucane <stephen at that.guru> wrote:

> Signed-off-by: Stephen Finucane <stephen at that.guru>
> ---
>  CONTRIBUTING.md  |   4 +-
>  CodingStyle.md   | 578 -------------------------------------------------
>  CodingStyle.rst  | 642 ++++++++++++++++++++++++++++++
> +++++++++++++++++++++++++
>  Makefile.am      |   4 +-
>  OPENFLOW-1.1+.md |   6 +-
>  5 files changed, 649 insertions(+), 585 deletions(-)
>  delete mode 100644 CodingStyle.md
>  create mode 100644 CodingStyle.rst
>

I made a couple of minor fixes and then applied this to master.

diff --git a/CodingStyle.rst b/CodingStyle.rst
index 2c2bb77..6b916f0 100644
--- a/CodingStyle.rst
+++ b/CodingStyle.rst
@@ -90,7 +90,7 @@ Comments
 Comments should be written as full sentences that start with a capital
letter
 and end with a period. Put two spaces between sentences.

-Write block comments as shown below. You may put the ``\*`` and ``*/`` on
the
+Write block comments as shown below. You may put the ``/*`` and ``*/`` on
the
 same line as comment text if you prefer.

 ::
diff --git a/OPENFLOW-1.1+.md b/OPENFLOW-1.1+.md
index e4c004f..cebaa17 100644
--- a/OPENFLOW-1.1+.md
+++ b/OPENFLOW-1.1+.md
@@ -313,5 +313,5 @@ Bug Reporting

 Please report problems to bugs at openvswitch.org.

-[CONTRIBUTING.rst]: CONTRIBUTING.rst
+[CONTRIBUTING.md]: CONTRIBUTING.md
 [CodingStyle.rst]: CodingStyle.rst



-- 
Russell Bryant



More information about the dev mailing list