Re: [ovs-dev] [PATCH 2/9] doc: Convert INSTALL to rST

2016-10-17 Thread Russell Bryant 
On Mon, Oct 17, 2016 at 8:19 AM, Stephen Finucane  wrote:

> On 15 Oct 22:01, Russell Bryant wrote:
> > On Sat, Oct 15, 2016 at 9:57 PM, Russell Bryant  wrote:
> > Very minor nit ... I think I would find it easier to review these if
> > content changes were separate from the md to rst conversion.  I also
> > understand that it's much easier to do the cleanups as you go during the
> > conversion.  I certainly don't want you to re-do these patches, but it's
> > something to keep in mind for future patches if separating formatting
> from
> > content is easy enough to do.
>
> Agreed. Most of those content changes are there from my initial
> attempts to migrate straight to Sphinx (before deciding a staged
> approach was wiser). I'll try to keep the noise down for the remaining
> transitions [*].
>
> Stephen
>
> [*] The one exception will be the Windows guide, which I rewrote based
> on the INSTALL.(md|rst) file and would be loathe to revert changes
> on :)
>

No problem.  This is all really great work.  I definitely don't want you to
waste time redoing anything you've already done.

-- 
Russell Bryant
___
dev mailing list
dev@openvswitch.org
http://openvswitch.org/mailman/listinfo/dev

Re: [ovs-dev] [PATCH 2/9] doc: Convert INSTALL to rST

2016-10-17 Thread Stephen Finucane 
On 15 Oct 22:01, Russell Bryant wrote:
> On Sat, Oct 15, 2016 at 9:57 PM, Russell Bryant  wrote:
> 
> >
> > On Sat, Oct 8, 2016 at 12:30 PM, Stephen Finucane 
> > wrote:
> >
> >> Signed-off-by: Stephen Finucane 
> >> ---
> >>  CONTRIBUTING.md  |   6 +-
> >>  FAQ.md   |  10 +-
> >>  INSTALL.DPDK-ADVANCED.md |   2 +-
> >>  INSTALL.DPDK.md  |   6 +-
> >>  INSTALL.Debian.md|   4 +-
> >>  INSTALL.Docker.md|   6 +-
> >>  INSTALL.Fedora.md|   6 +-
> >>  INSTALL.KVM.md   |   8 +-
> >>  INSTALL.Libvirt.md   |   4 +-
> >>  INSTALL.NetBSD.md|   4 +-
> >>  INSTALL.RHEL.md  |   6 +-
> >>  INSTALL.SELinux.md   |   2 +-
> >>  INSTALL.SSL.md   |   4 +-
> >>  INSTALL.XenServer.md |   6 +-
> >>  INSTALL.md   | 823 --
> >> --
> >>  INSTALL.rst  | 867 ++
> >> +
> >>  INSTALL.userspace.md |   4 +-
> >>  Makefile.am  |   2 +-
> >>  README.md|   6 +-
> >>  tutorial/Tutorial.md |   4 +-
> >>  20 files changed, 912 insertions(+), 868 deletions(-)
> >>  delete mode 100644 INSTALL.md
> >>  create mode 100644 INSTALL.rst
> >>
> >
> > I made a couple of minor changes to this patch.  I renamed the new
> > "Profiling" section header to "Valgrind", since I don't think the use of
> > valgrind here is for profiling, it's primarily for catching certain types
> > of errors.
> >
> > I also re-added the bug reporting section at the end of the document.

All fine by me.

> > diff --git a/INSTALL.rst b/INSTALL.rst
> > index a159b00..2b7f9b1 100644
> > --- a/INSTALL.rst
> > +++ b/INSTALL.rst
> > @@ -599,8 +599,8 @@ All the same options are avaiable via TESTSUITEFLAGS.
> > For example::
> >
> >  $ make check-lcov TESTSUITEFLAGS=-j8 -k ovn
> >
> > -Profiling
> > -+
> > +Valgrind
> > +
> >
> >  If you have ``valgrind`` installed, you can run the testsuite under
> >  valgrind by using the ``check-valgrind`` target::
> > @@ -865,3 +865,8 @@ Open vSwitch includes a Makefile target to trigger
> > static code analysis::
> >  You should invoke scan-view to view analysis results. The last line of
> > output
> >  from ``clang-analyze`` will list the command (containing results
> > directory)
> >  that you should invoke to view the results on a browser.
> > +
> > +Bug Reporting
> > +-
> > +
> > +Please report problems to b...@openvswitch.org.
> >
> >
> 
> Very minor nit ... I think I would find it easier to review these if
> content changes were separate from the md to rst conversion.  I also
> understand that it's much easier to do the cleanups as you go during the
> conversion.  I certainly don't want you to re-do these patches, but it's
> something to keep in mind for future patches if separating formatting from
> content is easy enough to do.

Agreed. Most of those content changes are there from my initial
attempts to migrate straight to Sphinx (before deciding a staged
approach was wiser). I'll try to keep the noise down for the remaining
transitions [*].

Stephen

[*] The one exception will be the Windows guide, which I rewrote based
on the INSTALL.(md|rst) file and would be loathe to revert changes
on :)
___
dev mailing list
dev@openvswitch.org
http://openvswitch.org/mailman/listinfo/dev

Re: [ovs-dev] [PATCH 2/9] doc: Convert INSTALL to rST

2016-10-15 Thread Russell Bryant 
On Sat, Oct 15, 2016 at 9:57 PM, Russell Bryant  wrote:

>
> On Sat, Oct 8, 2016 at 12:30 PM, Stephen Finucane 
> wrote:
>
>> Signed-off-by: Stephen Finucane 
>> ---
>>  CONTRIBUTING.md  |   6 +-
>>  FAQ.md   |  10 +-
>>  INSTALL.DPDK-ADVANCED.md |   2 +-
>>  INSTALL.DPDK.md  |   6 +-
>>  INSTALL.Debian.md|   4 +-
>>  INSTALL.Docker.md|   6 +-
>>  INSTALL.Fedora.md|   6 +-
>>  INSTALL.KVM.md   |   8 +-
>>  INSTALL.Libvirt.md   |   4 +-
>>  INSTALL.NetBSD.md|   4 +-
>>  INSTALL.RHEL.md  |   6 +-
>>  INSTALL.SELinux.md   |   2 +-
>>  INSTALL.SSL.md   |   4 +-
>>  INSTALL.XenServer.md |   6 +-
>>  INSTALL.md   | 823 --
>> --
>>  INSTALL.rst  | 867 ++
>> +
>>  INSTALL.userspace.md |   4 +-
>>  Makefile.am  |   2 +-
>>  README.md|   6 +-
>>  tutorial/Tutorial.md |   4 +-
>>  20 files changed, 912 insertions(+), 868 deletions(-)
>>  delete mode 100644 INSTALL.md
>>  create mode 100644 INSTALL.rst
>>
>
> I made a couple of minor changes to this patch.  I renamed the new
> "Profiling" section header to "Valgrind", since I don't think the use of
> valgrind here is for profiling, it's primarily for catching certain types
> of errors.
>
> I also re-added the bug reporting section at the end of the document.
>
> diff --git a/INSTALL.rst b/INSTALL.rst
> index a159b00..2b7f9b1 100644
> --- a/INSTALL.rst
> +++ b/INSTALL.rst
> @@ -599,8 +599,8 @@ All the same options are avaiable via TESTSUITEFLAGS.
> For example::
>
>  $ make check-lcov TESTSUITEFLAGS=-j8 -k ovn
>
> -Profiling
> -+
> +Valgrind
> +
>
>  If you have ``valgrind`` installed, you can run the testsuite under
>  valgrind by using the ``check-valgrind`` target::
> @@ -865,3 +865,8 @@ Open vSwitch includes a Makefile target to trigger
> static code analysis::
>  You should invoke scan-view to view analysis results. The last line of
> output
>  from ``clang-analyze`` will list the command (containing results
> directory)
>  that you should invoke to view the results on a browser.
> +
> +Bug Reporting
> +-
> +
> +Please report problems to b...@openvswitch.org.
>
>

Very minor nit ... I think I would find it easier to review these if
content changes were separate from the md to rst conversion.  I also
understand that it's much easier to do the cleanups as you go during the
conversion.  I certainly don't want you to re-do these patches, but it's
something to keep in mind for future patches if separating formatting from
content is easy enough to do.

Thanks,

-- 
Russell Bryant
___
dev mailing list
dev@openvswitch.org
http://openvswitch.org/mailman/listinfo/dev

Re: [ovs-dev] [PATCH 2/9] doc: Convert INSTALL to rST

2016-10-15 Thread Russell Bryant 
On Sat, Oct 8, 2016 at 12:30 PM, Stephen Finucane  wrote:

> Signed-off-by: Stephen Finucane 
> ---
>  CONTRIBUTING.md  |   6 +-
>  FAQ.md   |  10 +-
>  INSTALL.DPDK-ADVANCED.md |   2 +-
>  INSTALL.DPDK.md  |   6 +-
>  INSTALL.Debian.md|   4 +-
>  INSTALL.Docker.md|   6 +-
>  INSTALL.Fedora.md|   6 +-
>  INSTALL.KVM.md   |   8 +-
>  INSTALL.Libvirt.md   |   4 +-
>  INSTALL.NetBSD.md|   4 +-
>  INSTALL.RHEL.md  |   6 +-
>  INSTALL.SELinux.md   |   2 +-
>  INSTALL.SSL.md   |   4 +-
>  INSTALL.XenServer.md |   6 +-
>  INSTALL.md   | 823 --
> --
>  INSTALL.rst  | 867 ++
> +
>  INSTALL.userspace.md |   4 +-
>  Makefile.am  |   2 +-
>  README.md|   6 +-
>  tutorial/Tutorial.md |   4 +-
>  20 files changed, 912 insertions(+), 868 deletions(-)
>  delete mode 100644 INSTALL.md
>  create mode 100644 INSTALL.rst
>

I made a couple of minor changes to this patch.  I renamed the new
"Profiling" section header to "Valgrind", since I don't think the use of
valgrind here is for profiling, it's primarily for catching certain types
of errors.

I also re-added the bug reporting section at the end of the document.

diff --git a/INSTALL.rst b/INSTALL.rst
index a159b00..2b7f9b1 100644
--- a/INSTALL.rst
+++ b/INSTALL.rst
@@ -599,8 +599,8 @@ All the same options are avaiable via TESTSUITEFLAGS.
For example::

 $ make check-lcov TESTSUITEFLAGS=-j8 -k ovn

-Profiling
-+
+Valgrind
+

 If you have ``valgrind`` installed, you can run the testsuite under
 valgrind by using the ``check-valgrind`` target::
@@ -865,3 +865,8 @@ Open vSwitch includes a Makefile target to trigger
static code analysis::
 You should invoke scan-view to view analysis results. The last line of
output
 from ``clang-analyze`` will list the command (containing results directory)
 that you should invoke to view the results on a browser.
+
+Bug Reporting
+-
+
+Please report problems to b...@openvswitch.org.
___
dev mailing list
dev@openvswitch.org
http://openvswitch.org/mailman/listinfo/dev

[ovs-dev] [PATCH 2/9] doc: Convert INSTALL to rST

2016-10-08 Thread Stephen Finucane 
Signed-off-by: Stephen Finucane 
---
 CONTRIBUTING.md  |   6 +-
 FAQ.md   |  10 +-
 INSTALL.DPDK-ADVANCED.md |   2 +-
 INSTALL.DPDK.md  |   6 +-
 INSTALL.Debian.md|   4 +-
 INSTALL.Docker.md|   6 +-
 INSTALL.Fedora.md|   6 +-
 INSTALL.KVM.md   |   8 +-
 INSTALL.Libvirt.md   |   4 +-
 INSTALL.NetBSD.md|   4 +-
 INSTALL.RHEL.md  |   6 +-
 INSTALL.SELinux.md   |   2 +-
 INSTALL.SSL.md   |   4 +-
 INSTALL.XenServer.md |   6 +-
 INSTALL.md   | 823 
 INSTALL.rst  | 867 +++
 INSTALL.userspace.md |   4 +-
 Makefile.am  |   2 +-
 README.md|   6 +-
 tutorial/Tutorial.md |   4 +-
 20 files changed, 912 insertions(+), 868 deletions(-)
 delete mode 100644 INSTALL.md
 create mode 100644 INSTALL.rst

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6dc3a92..9d9f035 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -30,7 +30,7 @@ In particular:
 Testing is also important:
 
   - A patch that modifies existing code should be tested with `make
-check` before submission.  Please see INSTALL.md, under
+check` before submission.  Please see INSTALL.rst, under
 "Self-Tests", for more information.
 
   - A patch that adds or deletes files should also be tested with
@@ -50,7 +50,7 @@ Testing is also important:
 If you are using GitHub, then you may utilize the travis-ci.org CI build
 system by linking your GitHub repository to it. This will run some of
 the above tests automatically when you push changes to your repository.
-See the "Continuous Integration with Travis-CI" in the [INSTALL.md] file
+See the "Continuous Integration with Travis-CI" in the [INSTALL.rst] file
 for details on how to set it up.
 
 Email Subject
@@ -410,5 +410,5 @@ index fdd952e..f6cb88e 100644
 1.7.7.3
 ```
 
-[INSTALL.md]:INSTALL.md
+[INSTALL.rst]:INSTALL.rst
 [CodingStyle.md]:CodingStyle.md
diff --git a/FAQ.md b/FAQ.md
index b769f89..de595c5 100644
--- a/FAQ.md
+++ b/FAQ.md
@@ -851,7 +851,7 @@ A: On Linux kernels before 3.11, the OVS GRE module and 
Linux GRE module
dmesg for errors regarding GRE registration). To fix this, unload all
GRE modules that appear in lsmod as well as the OVS kernel module. You
can then reload the OVS module following the directions in
-   [INSTALL.md], which will ensure that dependencies are satisfied.
+   [INSTALL.rst], which will ensure that dependencies are satisfied.
 
 ### Q: Open vSwitch does not seem to obey my packet filter rules.
 
@@ -2098,7 +2098,7 @@ A: Add your new message to "enum ofpraw" and "enum 
ofptype" in
lib/ofp-msgs.h, following the existing pattern.  Then recompile and
fix all of the new warnings, implementing new functionality for the
new message as needed.  (If you configure with --enable-Werror, as
-   described in [INSTALL.md], then it is impossible to miss any warnings.)
+   described in [INSTALL.rst], then it is impossible to miss any warnings.)
 
If you need to add an OpenFlow vendor extension message for a
vendor that doesn't yet have any extension messages, then you will
@@ -2114,7 +2114,7 @@ A: Add new members for your field to "struct flow" in 
lib/flow.h, and
lib/nx-match.c to output your new field in OXM matches.  Then
recompile and fix all of the new warnings, implementing new
functionality for the new field or header as needed.  (If you
-   configure with --enable-Werror, as described in [INSTALL.md], then
+   configure with --enable-Werror, as described in [INSTALL.rst], then
it is impossible to miss any warnings.)
 
If you want kernel datapath support for your new field, you also
@@ -2135,7 +2135,7 @@ A: Add your new action to "enum ofp_raw_action_type" in
lib/ofp-actions.c, following the existing pattern.  Then recompile
and fix all of the new warnings, implementing new functionality for
the new action as needed.  (If you configure with --enable-Werror,
-   as described in [INSTALL.md], then it is impossible to miss any
+   as described in [INSTALL.rst], then it is impossible to miss any
warnings.)
 
If you need to add an OpenFlow vendor extension action for a vendor
@@ -2151,7 +2151,7 @@ http://openvswitch.org/
 
 [PORTING.md]:PORTING.md
 [WHY-OVS.md]:WHY-OVS.md
-[INSTALL.md]:INSTALL.md
+[INSTALL.rst]:INSTALL.rst
 [OPENFLOW-1.1+.md]:OPENFLOW-1.1+.md
 [INSTALL.DPDK.md]:INSTALL.DPDK.md
 [Tutorial.md]:tutorial/Tutorial.md
diff --git a/INSTALL.DPDK-ADVANCED.md b/INSTALL.DPDK-ADVANCED.md
index 555f026..cf5023c 100644
--- a/INSTALL.DPDK-ADVANCED.md
+++ b/INSTALL.DPDK-ADVANCED.md
@@ -880,7 +880,7 @@ Please report problems to b...@openvswitch.org.
 
 
 [INSTALL.userspace.md]:INSTALL.userspace.md
-[INSTALL.md]:INSTALL.md
+[INSTALL.rst]:INSTALL.rst
 [DPDK Linux GSG]: