Re: [ovs-dev] [PATCH 6/9] doc: Convert INSTALL.Windows to rST

2016-10-18 Thread Russell Bryant
On Tue, Oct 18, 2016 at 2:55 PM, Stephen Fincane  wrote:

> On Tue, 2016-10-18 at 14:18 -0400, Russell Bryant wrote:
> > The old doc used "% command" as the prompt prefix.  I see that in the
> > new doc it is "$ command".  I'm not a Windows person, but from a
> > quick look, I think "> command" may be the most natural thing to use,
> > so I converted it to that.
>
> I could be wrong, but I *think* it has to be '$' for syntax
> highlighting to work correctly (I initially used '#' for sudo command,
> per OpenStack docs guide, but that didn't parse). No matter though -
> we'll switch to '.. code-block:: bash' style markup once we move to
> Sphinx which should resolve this anyway :)
>

No syntax highlighting is happening in the current HTML renders of these
docs, so I didn't notice.  I already pushed this, but we can change it when
we get to sphinx if needed.

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


Re: [ovs-dev] [PATCH 6/9] doc: Convert INSTALL.Windows to rST

2016-10-18 Thread Stephen Fincane
On Tue, 2016-10-18 at 14:18 -0400, Russell Bryant wrote:
> The old doc used "% command" as the prompt prefix.  I see that in the
> new doc it is "$ command".  I'm not a Windows person, but from a
> quick look, I think "> command" may be the most natural thing to use,
> so I converted it to that.

I could be wrong, but I *think* it has to be '$' for syntax
highlighting to work correctly (I initially used '#' for sudo command,
per OpenStack docs guide, but that didn't parse). No matter though -
we'll switch to '.. code-block:: bash' style markup once we move to
Sphinx which should resolve this anyway :)

Stephen
___
dev mailing list
dev@openvswitch.org
http://openvswitch.org/mailman/listinfo/dev


Re: [ovs-dev] [PATCH 6/9] doc: Convert INSTALL.Windows to rST

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

> This has been extensively reworked such that the format of the document
> matches that of INSTALL.rst. The sum of the content remains the same,
> however.
>
> Signed-off-by: Stephen Finucane 
> ---
>  INSTALL.Windows.md  | 527 
>  INSTALL.Windows.rst | 621 ++
> ++
>  INSTALL.rst |   2 +-
>  Makefile.am |   2 +-
>  4 files changed, 623 insertions(+), 529 deletions(-)
>  delete mode 100644 INSTALL.Windows.md
>  create mode 100644 INSTALL.Windows.rst
>
>


> +Bootstrapping
> +-
> +
> +This step is not needed if you have downloaded a released tarball. If
> +you pulled the sources directly from an Open vSwitch Git tree or got a
> +Git tree snapshot, then run boot.sh in the top source directory to build
> +the "configure" script:::
> +
> +$ ./boot.sh
>


The old doc used "% command" as the prompt prefix.  I see that in the new
doc it is "$ command".  I'm not a Windows person, but from a quick look, I
think "> command" may be the most natural thing to use, so I converted it
to that.

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