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

[Russell Bryant]

On Sat, Oct 15, 2016 at 9:57 PM, Russell Bryant <russell at ovn.org> wrote:

>
> On Sat, Oct 8, 2016 at 12:30 PM, Stephen Finucane <stephen at that.guru>
> wrote:
>
>> Signed-off-by: Stephen Finucane <stephen at that.guru>
>> ---
>>  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 bugs at 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