Re: [ovs-dev] [PATCH] doc: Describe backporting process.

2017-02-16 Thread Stephen Finucane
rprising or new; it merely puts the existing process into words. > > Signed-off-by: Joe Stringer <j...@ovn.org> > Acked-by: Ben Pfaff <b...@ovn.org> Excellent guide - I had no idea OVS and the net-next tree were as closely related as they are. Couple of nits below but nothing I'd b

Re: [ovs-dev] manpages in rst?

2017-02-17 Thread Stephen Finucane
On Thu, 2017-02-16 at 09:24 -0800, Ben Pfaff wrote: > Currently, we have some manpages written directly in nroff.  This is > an > awful format, that is difficult to read and difficult to > write.  Other > manpages are written in a custom XML format that, while it is easier > to > read and write,

[ovs-dev] [PATCH] doc: Remove final markdown references

2016-11-07 Thread Stephen Finucane
There are some leftover Markdown references and Markdown-related tooling. Seeing as there are no Markdown files left, we can kill it all with fire. Signed-off-by: Stephen Finucane <step...@that.guru> --- DocumentationStyle.rst | 2 +- INSTALL.rst| 2 +- README.rst

Re: [ovs-dev] [PATCH] doc: Remove final markdown references

2016-11-07 Thread Stephen Finucane
On 2016-11-07 22:20, Russell Bryant wrote: On Mon, Nov 7, 2016 at 2:03 PM, Russell Bryant <russ...@ovn.org> wrote: On Mon, Nov 7, 2016 at 3:22 AM, Stephen Finucane <step...@that.guru> wrote: There are some leftover Markdown references and Markdown-related too

[ovs-dev] [PATCH 05/14] doc: Create directory structure

2016-11-22 Thread Stephen Finucane
themselves. [1] https://jacobian.org/writing/great-documentation/ Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk | 10 - Documentation/contents.rst| 11 ++ Documentation/faq/index.rst

[ovs-dev] [PATCH 08/14] doc: Populate 'install', 'howto' sections

2016-11-22 Thread Stephen Finucane
This is a dumb move of all 'INSTALL*' docs, with very little refactoring (mostly updating links and making the titles a little more consistent. Additional refactoring will be done in subsequent changes. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/autom

[ovs-dev] [PATCH 10/14] doc: Populate 'topics' section

2016-11-22 Thread Stephen Finucane
There are many docs that don't need to kept at the top level, along with many more hidden in random folders. Move them all. This also allows us to add the '-W' flag to Sphinx, ensuring unindexed docs result in build failures. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documen

[ovs-dev] [PATCH 09/14] doc: Further populate the 'howto' section

2016-11-22 Thread Stephen Finucane
There are a couple of references to these for various build systems. The website is going to be our "one true resource" for all docs, so simply remove these references. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk

[ovs-dev] [PATCH 00/14] Sphinx-ification of documentation

2016-11-22 Thread Stephen Finucane
you agree. Stephen Finucane (14): trivial: Don't mix tabs and spaces in ovs-sim doc: Don't format emails as code doc: Convert AUTHORS to rST Add initial sphinx configuration doc: Create directory structure doc: Populate 'ref' section doc: Populate 'internals' section doc: Populate

[ovs-dev] [PATCH 01/14] trivial: Don't mix tabs and spaces in ovs-sim

2016-11-22 Thread Stephen Finucane
Signed-off-by: Stephen Finucane <step...@that.guru> --- utilities/ovs-sim.in | 100 +++ xenserver/etc_init.d_openvswitch | 18 +++ 2 files changed, 59 insertions(+), 59 deletions(-) diff --git a/utilities/ovs-sim.in b/utilities/ovs-

[ovs-dev] [PATCH 03/14] doc: Convert AUTHORS to rST

2016-11-22 Thread Stephen Finucane
Signed-off-by: Stephen Finucane <step...@that.guru> --- I don't know if the script in debian/automake.mk has been done correctly, as I can't build a package to validate it (Fedora). This needs to be checked and possibly corrected. --- AUTHORS

[ovs-dev] [PATCH 07/14] doc: Populate 'internals' section

2016-11-22 Thread Stephen Finucane
This is mostly docs moved from the top-level directory and content scraped from the Open vSwitch website source [1]. [1] https://github.com/openvswitch/openvswitch.github.io/ Signed-off-by: Stephen Finucane <step...@that.guru> --- CONTRIBUTING.rst

[ovs-dev] [PATCH 11/14] doc: Populate 'tutorials' section

2016-11-22 Thread Stephen Finucane
Rename 'tutorial' to 'ovs-advanced' and 'ovn-tutorial' to 'ovn-basics'. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk| 2 ++ Documentation/index.rst | 3 ++- Documentation/tutorials/ind

[ovs-dev] [PATCH 14/14] doc: Remove documentation from distdoc target

2016-11-22 Thread Stephen Finucane
Basic Sphinx integration is now complete. Remove the documentation aspects of the 'dist-docs' target in favor of the htmldocs target. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk | 4 +--- Makefile.am | 7 +-- build-aux/dis

Re: [ovs-dev] [PATCH 3/3 v6] Windows: document multiple NIC support setup

2016-11-29 Thread Stephen Finucane
On Mon, 2016-11-28 at 16:36 +, Alin Serdean wrote: > This patch updates the documentation on how to set up OVS with > multiple > NICs. > > Also update the documentation to show users how new internal ports > are > created > > Signed-off-by: Alin Gabriel Serdean

[ovs-dev] [PATCH v2 05/11] doc: Populate 'install', 'howto' sections

2016-12-08 Thread Stephen Finucane
This is a dumb move of all 'INSTALL*' docs, with very little refactoring (mostly updating links and making the titles a little more consistent. Additional refactoring will be done in subsequent changes. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/autom

[ovs-dev] [PATCH v2 01/11] Add initial sphinx configuration

2016-12-08 Thread Stephen Finucane
need to include a TOC on the home page - The theme is switched to 'bizstyle', which makes better use of horizontal real estate than the default 'alabaster' theme Copyright is assigned to "The Open vSwitch Development Community". Signed-off-by: Stephen Finucane <step...@that.guru>

[ovs-dev] [PATCH v2 06/11] doc: Further populate the 'howto' section

2016-12-08 Thread Stephen Finucane
There are a couple of references to these for various build systems. The website is going to be our "one true resource" for all docs, so simply remove these references. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk

[ovs-dev] [PATCH v2 07/11] doc: Populate 'topics' section

2016-12-08 Thread Stephen Finucane
There are many docs that don't need to kept at the top level, along with many more hidden in random folders. Move them all. This also allows us to add the '-W' flag to Sphinx, ensuring unindexed docs result in build failures. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documen

[ovs-dev] [PATCH v2 08/11] doc: Populate 'tutorials' section

2016-12-08 Thread Stephen Finucane
Rename 'tutorial' to 'ovs-advanced' and 'ovn-tutorial' to 'ovn-basics'. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk| 2 ++ Documentation/index.rst | 3 ++- Documentation/tutorials/ind

[ovs-dev] [PATCH v2 04/11] doc: Populate 'internals' section

2016-12-08 Thread Stephen Finucane
This is mostly docs moved from the top-level directory and content scraped from the Open vSwitch website source [1]. [1] https://github.com/openvswitch/openvswitch.github.io/ Signed-off-by: Stephen Finucane <step...@that.guru> --- CONTRIBUTING.rst

[ovs-dev] [PATCH v2 11/11] doc: Remove documentation from distdoc target

2016-12-08 Thread Stephen Finucane
Basic Sphinx integration is now complete. Remove the documentation aspects of the 'dist-docs' target in favor of the htmldocs target. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk | 4 +--- Makefile.am | 7 +-- build-aux/dis

[ovs-dev] [PATCH v2 09/11] doc: Move WHY-OVS

2016-12-08 Thread Stephen Finucane
This is moved separately due to the sheer number of references to this file in the codebase. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk | 1 + Documentation/intro/index.rst | 1 + WHY-OVS.rst => Documentation/

[ovs-dev] [PATCH v2 03/11] doc: Populate 'ref' section

2016-12-08 Thread Stephen Finucane
This is a simple table with links to the manpages published on openvswitch.org. Something fancier can be done in the future. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/ref/index.rst | 144 +++- 1 file changed, 143 inse

[ovs-dev] [PATCH v2 02/11] doc: Create directory structure

2016-12-08 Thread Stephen Finucane
themselves. [1] https://jacobian.org/writing/great-documentation/ Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk | 10 - Documentation/contents.rst| 11 ++ Documentation/faq/index.rst

[ovs-dev] [PATCH v2 00/11] Sphinx-ification of documentation

2016-12-08 Thread Stephen Finucane
still apply. https://mail.openvswitch.org/pipermail/ovs-dev/2016-November/325292.html Changes since v1: - Rebase onto master Stephen Finucane (11): Add initial sphinx configuration doc: Create directory structure doc: Populate 'ref' section doc: Populate 'internals' section doc

Re: [ovs-dev] [PATCH v2 00/11] Sphinx-ification of documentation

2016-12-13 Thread Stephen Finucane
ibuted.  I fixed those.  Second, I changed the default > SPHINXBUILDDIR from $(srcdir) to $(builddir). Thank you. docs.openvswitch.org looks good :) Stephen > On Thu, Dec 08, 2016 at 12:55:19PM +, Stephen Finucane wrote: > > This series is the first in a number of planned series that

[ovs-dev] [PATCH v2 1/4] doc: Split dpdk, dpdk-advanced into multiple docs

2016-12-14 Thread Stephen Finucane
-install aspects of the dpdk document into these sections. This aims to tie the DPDK docs into the documentation structure. Signed-off-by: Stephen Finucane <step...@that.guru> --- v2: - Resolve merge conflicts --- Documentation/automake.mk | 6 +- Documentation

[ovs-dev] [PATCH v2 3/4] doc: Document Patchwork instance

2016-12-14 Thread Stephen Finucane
I know more than a little bit about this :) Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk | 1 + Documentation/index.rst | 1 + Documentation/internals/index.rst | 1 + Documentation/internals/patchwork.rs

[ovs-dev] [PATCH v2 0/4] doc: Rework DPDK guide

2016-12-14 Thread Stephen Finucane
As promised, this series reworks the largest of the installation guides to suit the new structure of the documentation. A couple of related patches are included to build upon this. Changes since v2: - Rebase onto master Stephen Finucane (4): doc: Split dpdk, dpdk-advanced into multiple docs

Re: [ovs-dev] [PATCH 2/4] trivial: Consistently indent HTML with 2 spaces

2016-12-14 Thread Stephen Finucane
On Tue, 2016-12-13 at 11:41 -0800, Ben Pfaff wrote: > On Tue, Dec 13, 2016 at 05:57:22PM +0000, Stephen Finucane wrote: > > This will make upcoming changes easier to review. > > > > Signed-off-by: Stephen Finucane <step...@that.guru> > > "git am" tell

Re: [ovs-dev] [PATCH] docs: Add link to man pages.

2016-12-14 Thread Stephen Finucane
On Tue, 2016-12-13 at 15:09 -0500, Russell Bryant wrote: > > > On Tue, Dec 13, 2016 at 1:30 PM, Stephen Finucane <step...@that.guru> > wrote: > > On Tue, 2016-12-13 at 18:17 +, Stephen Finucane wrote: > > > On Tue, 2016-12-13 at 10:57 -0500, Russell Bryant

[ovs-dev] [PATCH v2 2/4] doc: Move testing to testing section

2016-12-14 Thread Stephen Finucane
This makes more sense here, seeing as it's not exactly installation related. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/intro/install/general.rst | 348 +-- Documentation/topics/testing.rst| 359 +

[ovs-dev] [PATCH v2 4/4] gitignore: Ignore venv

2016-12-14 Thread Stephen Finucane
This is the traditional name for Python virtualenv directories. I use this when building docs to avoid installating system libraries. Signed-off-by: Stephen Finucane <step...@that.guru> --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index f

[ovs-dev] [PATCH 5/5] gitignore: Ignore venv

2016-12-13 Thread Stephen Finucane
This is the traditional name for Python virtualenv directories. I use this when building docs to avoid installating system libraries. Signed-off-by: Stephen Finucane <step...@that.guru> --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index f

[ovs-dev] [PATCH 3/5] doc: Move testing to testing section

2016-12-13 Thread Stephen Finucane
This makes more sense here, seeing as it's not exactly installation related. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/intro/install/general.rst | 348 +-- Documentation/topics/testing.rst| 359 +

[ovs-dev] [PATCH 4/5] doc: Document Patchwork instance

2016-12-13 Thread Stephen Finucane
I know more than a little bit about this :) Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk | 1 + Documentation/index.rst | 1 + Documentation/internals/index.rst | 1 + Documentation/internals/patchwork.rs

[ovs-dev] [PATCH 0/5] doc: Rework DPDK guide

2016-12-13 Thread Stephen Finucane
As promised, this series reworks the largest of the installation guides to suit the new structure of the documentation. A couple of related patches are included to build upon this. Stephen Finucane (5): doc: Use higher resolution logo doc: Split dpdk, dpdk-advanced into multiple docs doc

[ovs-dev] [PATCH 1/5] doc: Use higher resolution logo

2016-12-13 Thread Stephen Finucane
Rework the logo to remove much of the white background and increase resolution. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/_static/logo.png | Bin 13341 -> 672215 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/Documentation/_static/l

[ovs-dev] [PATCH 1/4] Integrate docker

2016-12-13 Thread Stephen Finucane
This means you don't need to install Ruby and requirements to build the website locally. Jekyll 2.x is used as there are incompatible plugins present - an issue which should be resolved separately. Signed-off-by: Stephen Finucane <step...@that.guru> --- docker-compose.yml | 7 +++

[ovs-dev] [PATCH 3/4] Make Open vSwitch mobile-compatible

2016-12-13 Thread Stephen Finucane
There are a couple of changes needed: - Use a responsive-style grid - Remove unnecessary tags - Use semantic HTML5 tags - Reorder CSS into logical sections - Scroll on overflow of pre tags Signed-off-by: Stephen Finucane <step...@that.guru> --- _includes/footer.html

[ovs-dev] [PATCH 4/4] Merge docs into README

2016-12-13 Thread Stephen Finucane
More readable. Less weird filenames. Winning. Signed-off-by: Stephen Finucane <step...@that.guru> --- README.md | 156 +++--- _BUILD| 28 --- _DOC | 78 --- _TODO | 40 -

Re: [ovs-dev] [PATCH] docs: Add link to man pages.

2016-12-13 Thread Stephen Finucane
+61,8 @@ vSwitch? Start here. >  Deeper Dive >  --- >   > -**TODO** > +Detailed man pages can be found on openvswitch.org > +(http://openvswitch.org/support/dist-docs/). Perhaps: `openvswitch.org <http://openvswitch.org/support/dist-docs/>`__ might be a little cleaner? That

Re: [ovs-dev] [PATCH] docs: Add link to man pages.

2016-12-13 Thread Stephen Finucane
On Tue, 2016-12-13 at 18:17 +, Stephen Finucane wrote: > On Tue, 2016-12-13 at 10:57 -0500, Russell Bryant wrote: > > Our new docs site does not yet include all of the man pages.  Add a > > link > > to where they are currently hosted on openvswitch.org. > > Working

[ovs-dev] [PATCH 2/4] trivial: Consistently indent HTML with 2 spaces

2016-12-13 Thread Stephen Finucane
This will make upcoming changes easier to review. Signed-off-by: Stephen Finucane <step...@that.guru> --- _includes/footer.html | 6 +-- _includes/header.html | 21 _includes/menulist.html| 19 --- _includes/side-widgets.html

[ovs-dev] [PATCH 2/2] doc: Add link to manpages guide

2016-12-13 Thread Stephen Finucane
This was included only in the contents page. Signed-off-by: Stephen Finucane <step...@that.guru> Reported-by: Russell Bryant <russ...@ovn.org> --- Documentation/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/index.rst b/Documentation/ind

Re: [ovs-dev] [PATCH 2/4] trivial: Consistently indent HTML with 2 spaces

2016-12-14 Thread Stephen Finucane
On Wed, 2016-12-14 at 09:46 -0800, Ben Pfaff wrote: > On Wed, Dec 14, 2016 at 09:27:41AM -0800, Ben Pfaff wrote: > > On Wed, Dec 14, 2016 at 10:10:08AM +, Stephen Finucane wrote: > > > On Tue, 2016-12-13 at 11:41 -0800, Ben Pfaff wrote: > > > > On Tue, Dec 13, 201

Re: [ovs-dev] [PATCH 2/4] trivial: Consistently indent HTML with 2 spaces

2016-12-14 Thread Stephen Finucane
On Wed, 2016-12-14 at 11:25 -0800, Ben Pfaff wrote: > On Wed, Dec 14, 2016 at 06:27:13PM +0000, Stephen Finucane wrote: > > On Wed, 2016-12-14 at 10:06 -0800, Ben Pfaff wrote: > > > On Wed, Dec 14, 2016 at 05:59:44PM +, Stephen Finucane wrote: > > > > On Wed,

Re: [ovs-dev] [PATCH 2/4] trivial: Consistently indent HTML with 2 spaces

2016-12-14 Thread Stephen Finucane
On Wed, 2016-12-14 at 10:06 -0800, Ben Pfaff wrote: > On Wed, Dec 14, 2016 at 05:59:44PM +0000, Stephen Finucane wrote: > > On Wed, 2016-12-14 at 09:46 -0800, Ben Pfaff wrote: > > > On Wed, Dec 14, 2016 at 09:27:41AM -0800, Ben Pfaff wrote: > > > > On Wed, Dec 14, 201

[ovs-dev] [PATCH 3/5] doc: Add sFlow cookbook from website

2016-12-17 Thread Stephen Finucane
This is mostly copied verbatim. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk | 2 + Documentation/howto/index.rst | 1 + Documentation/howto/sflow.png | Bin 0 -> 85755 bytes Documentation/howto/sflow.

[ovs-dev] [PATCH 5/5] doc: Add DPDK to userspace tunneling guide

2016-12-17 Thread Stephen Finucane
Instructions were provided in the userspace tunneling cookbook. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk | 2 +- Documentation/howto/index.rst | 2 +- Documentation/howto/native-tunneling.rst

[ovs-dev] [PATCH 1/5] doc: Add vlan cookbook from website

2016-12-17 Thread Stephen Finucane
This is mostly copied verbatim. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk | 2 + Documentation/howto/index.rst | 1 + Documentation/howto/vlan.png | Bin 0 -> 83598 bytes Documentation/howto/vlan.r

[ovs-dev] [PATCH 1/6] doc: Add some useful tools for doc editing

2016-12-17 Thread Stephen Finucane
This has come up on the mailing list. Let's document it! Signed-off-by: Stephen Finucane <step...@that.guru> --- .../internals/contributing/documentation-style.rst | 29 +++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/Documentation/internals/contri

[ovs-dev] [PATCH 3/6] doc: Add info on building documentation

2016-12-17 Thread Stephen Finucane
I know how to do this, but does anyone else? Let's make it obvious and ease the cognitive load on the great folks writing docs. Links to the various packaging guides, previously missing, are included on the main page. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documen

[ovs-dev] [PATCH 4/6] doc: Misc fixes to 'bash-completion'

2016-12-17 Thread Stephen Finucane
Fix some minor formatting issues with this document. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/intro/install/bash-completion.rst | 27 ++--- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/Documentation/intro/instal

[ovs-dev] [PATCH 6/6] doc: Add a 'what-is-ovs' document

2016-12-17 Thread Stephen Finucane
Add description of Open vSwitch from README, along with the overview image from openvswitch.org. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/_static/overview.jpg | Bin 0 -> 105786 bytes Documentation/automake.mk | 1 + Documentation/

[ovs-dev] [PATCH 5/6] doc: Document various language bindings

2016-12-17 Thread Stephen Finucane
Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk | 1 + Documentation/index.rst| 2 + Documentation/topics/index.rst | 1 + Documentation/topics/language-bindings.rst | 60 ++ 4

[ovs-dev] [PATCH 4/5] doc: Add port tunneling cookbook from website

2016-12-17 Thread Stephen Finucane
Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk | 2 + Documentation/howto/index.rst | 1 + Documentation/howto/tunneling.png | Bin 0 -> 72197 bytes Documentation/howto/tunneling.rst | 165 ++ 4 file

Re: [ovs-dev] [PATCH 04/14] Add initial sphinx configuration

2016-12-01 Thread Stephen Finucane
On Wed, 2016-11-30 at 21:05 -0500, Russell Bryant wrote: > > On Wed, Nov 30, 2016 at 9:02 PM, Russell Bryant <russ...@ovn.org> > wrote: > > > > On Tue, Nov 22, 2016 at 1:18 PM, Stephen Finucane <step...@that.gur > > u> wrote: > > > This

Re: [ovs-dev] [PATCH] build: fix rpm-fedora target breakage

2016-12-01 Thread Stephen Finucane
On Wed, 2016-11-30 at 20:56 -0800, Ben Pfaff wrote: > On Wed, Nov 30, 2016 at 10:57:25PM -0500, Lance Richardson wrote: > > Since commit 3deca69b08f2 ("doc: Convert AUTHORS to rST"), the rpm- > > fedora > > target fails to build with: > > > >   *** No rule to make target `AUTHORS.rst', needed by

Re: [ovs-dev] [PATCH] CONTRIBUTING.rst: Update patch summary and description style guidelines.

2016-12-01 Thread Stephen Finucane
On Wed, 2016-11-30 at 12:40 -0800, Ben Pfaff wrote: > Suggested-by: Joe Stringer > Suggested-at: https://mail.openvswitch.org/pipermail/ovs-dev/2016-Nov > ember/325513.html > Signed-off-by: Ben Pfaff > --- >  CONTRIBUTING.rst | 12 ++-- >  1 file changed, 10

Re: [ovs-dev] [PATCH] CONTRIBUTING.rst: Update patch summary and description style guidelines.

2016-12-02 Thread Stephen Finucane
On Thu, 2016-12-01 at 15:59 -0800, Ben Pfaff wrote: > On Thu, Dec 01, 2016 at 01:16:14PM +0000, Stephen Finucane wrote: > > On Wed, 2016-11-30 at 12:40 -0800, Ben Pfaff wrote: > > > Suggested-by: Joe Stringer <j...@ovn.org> > > > Suggested-at: https://mail.openv

Re: [ovs-dev] [PATCH v5 1/3] netdev-dpdk: add hotplug support

2017-01-05 Thread Stephen Finucane
com> The docs aspects of all three patches all look a-OK to me now. Cheers :) Acked-by: Stephen Finucane <step...@that.guru> # docs only ___ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev

Re: [ovs-dev] [PATCH] doc: Use ovs theme

2017-01-05 Thread Stephen Finucane
On Wed, 2017-01-04 at 10:32 -0800, Joe Stringer wrote: > On 4 January 2017 at 01:03, Stephen Finucane <step...@that.guru> > wrote: > > On Tue, 2017-01-03 at 21:33 +, Stephen Finucane wrote: > > > The recently published 'ovs' theme [1] copies the styling of the >

[ovs-dev] [PATCH v2 3/5] make: Check for Sphinx before checking docs

2017-01-02 Thread Stephen Finucane
Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk | 6 -- configure.ac | 1 + m4/openvswitch.m4 | 14 +- 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/Documentation/automake.mk b/Documentation/autom

[ovs-dev] [PATCH v2 5/5] make: Standardize indentation

2017-01-02 Thread Stephen Finucane
If we're going to mix tabs and spaces, let's do it consistently. Signed-off-by: Stephen Finucane <step...@that.guru> --- Makefile.am | 178 ++-- 1 file changed, 89 insertions(+), 89 deletions(-) diff --git a/Makefile.am b/Makefile.am

[ovs-dev] [PATCH v2 2/5] make: Add distinct clean-docs target

2017-01-02 Thread Stephen Finucane
Speed things up by not rebuilding documents every time. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk | 6 +- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Documentation/automake.mk b/Documentation/automake.mk index cb41d11..ac147a7

[ovs-dev] [PATCH] doc: Use ovs theme

2017-01-03 Thread Stephen Finucane
+. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/conf.py | 20 Documentation/requirements.txt | 3 ++- 2 files changed, 18 insertions(+), 5 deletions(-) diff --git a/Documentation/conf.py b/Documentation/conf.py index 63f5877..c0b68c1

[ovs-dev] [PATCH] doc: Add missing ':'

2017-01-03 Thread Stephen Finucane
Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/tutorials/ovs-advanced.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/tutorials/ovs-advanced.rst b/Documentation/tutorials/ovs-advanced.rst index d14b2f9..de1e7d0

Re: [ovs-dev] [PATCH] docs: Fix formatting of patch comments line.

2017-01-05 Thread Stephen Finucane
y: Joe Stringer <j...@ovn.org> Aye, good catch. Acked-by: Stephen Finucane <step...@that.guru> ___ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev

[ovs-dev] [PATCH] travis: Install python-sphinx

2017-01-04 Thread Stephen Finucane
This will ensure the recently added 'check-docs' target will get run as part of Travis. Signed-off-by: Stephen Finucane <step...@that.guru> Cc: Ben Pfaff <b...@ovn.org> --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index 90fc699..d0

Re: [ovs-dev] [PATCH v2 4/5] make: Ensure flake8, sphinx run when required

2017-01-04 Thread Stephen Finucane
On Wed, 2017-01-04 at 08:20 -0800, Ben Pfaff wrote: > On Mon, Jan 02, 2017 at 11:47:41AM +0000, Stephen Finucane wrote: > > If someone makes changes to documentation or Python scripts, they > > should > > validate these changes using the relevant targets. However, said > &g

Re: [ovs-dev] [PATCH] doc: Use ovs theme

2017-01-04 Thread Stephen Finucane
On Wed, 2017-01-04 at 08:32 -0800, Ben Pfaff wrote: > On Wed, Jan 04, 2017 at 04:06:26PM +0000, Stephen Finucane wrote: > > On Wed, 2017-01-04 at 08:00 -0800, Ben Pfaff wrote: > > > On Wed, Jan 04, 2017 at 09:03:04AM +, Stephen Finucane wrote: > > > > On Tue, 2017

Re: [ovs-dev] [PATCH v2 4/5] make: Ensure flake8, sphinx run when required

2017-01-04 Thread Stephen Finucane
On Wed, 2017-01-04 at 08:34 -0800, Ben Pfaff wrote: > On Wed, Jan 04, 2017 at 04:25:40PM +0000, Stephen Finucane wrote: > > On Wed, 2017-01-04 at 08:20 -0800, Ben Pfaff wrote: > > > On Mon, Jan 02, 2017 at 11:47:41AM +, Stephen Finucane wrote: > > > > If someone

Re: [ovs-dev] [PATCH] doc: Use ovs theme

2017-01-04 Thread Stephen Finucane
On Wed, 2017-01-04 at 08:00 -0800, Ben Pfaff wrote: > On Wed, Jan 04, 2017 at 09:03:04AM +0000, Stephen Finucane wrote: > > On Tue, 2017-01-03 at 21:33 +, Stephen Finucane wrote: > > > The recently published 'ovs' theme [1] copies the styling of the > > > Open &

Re: [ovs-dev] [PATCH v4 1/3] netdev-dpdk: add hotplug support

2017-01-04 Thread Stephen Finucane
On Wed, 2017-01-04 at 15:31 +, Ciara Loftus wrote: > In order to use dpdk ports in ovs they have to be bound to a DPDK > compatible driver before ovs is started. > > This patch adds the possibility to hotplug (or hot-unplug) a device > after ovs has been started. The implementation adds two

[ovs-dev] [PATCH] doc: Don't limit ourselves to flake8 2.x

2017-01-04 Thread Stephen Finucane
There was a bug when using hacking with flake8 3.x. This bug has since been resolved [1], meaning we no longer need to call out the need to use the older version of flake8. [1] https://review.openstack.org/#/c/335965/ Signed-off-by: Stephen Finucane <step...@that.guru> --- .travis

Re: [ovs-dev] [PATCH 1/2] doc: Remove ivshmem instructions.

2017-01-03 Thread Stephen Finucane
EMU has never >   been upstreamed and does not apply to the last 4 QEMU releases. > - Userspace vhost has become the defacto OVS-DPDK path to the guest. > > Fixes: 04de404e1bfa ("netdev-dpdk: Add support for DPDK 16.11") > Cc: Ciara Loftus <ciara.lof...@intel.com> > Cc:

[ovs-dev] [PATCH] doc: Correct type of highlighting

2016-12-23 Thread Stephen Finucane
Some recent changes marked code as Powershell when in fact it was DOS or bash shell. This incorrect highlighting actually breaks the local build (where warnings are treated as errors) as pygments is unable to lex all the code as PowerShell. Fix these types. Signed-off-by: Stephen Finucane <s

[ovs-dev] [PATCH 2/3] doc: Misc Windows doc formatting fixes

2016-12-21 Thread Stephen Finucane
all of these through use of the 'code-block' element and a lot of random fixes. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/intro/install/windows.rst | 496 +++- 1 file changed, 294 insertions(+), 202 deletions(-) diff --git a/Documentation/intr

[ovs-dev] [PATCH 1/3] doc: Resolve issues with Windows guide

2016-12-21 Thread Stephen Finucane
The formatting of this file was broken in a recent commit. Resolve this issue. Signed-off-by: Stephen Finucane <step...@that.guru> Fixes: a0c03adff6c2 ("Windows: document multiple NIC support setup") Cc: Alin Gabriel Serdean <aserd...@cloudbasesolutions.com> --- Docum

[ovs-dev] [PATCH 3/3] doc: Prefer use of 'code-block' directive

2016-12-21 Thread Stephen Finucane
The '::' element previously preferred is shorter, but does not allow for non-Python syntax highlighting. New documentation should make use of syntax highlighting wherever possible. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/internals/contributing/documen

Re: [ovs-dev] [PATCH] doc: Correct type of highlighting

2016-12-23 Thread Stephen Finucane
On Fri, 2016-12-23 at 08:54 -0800, Ben Pfaff wrote: > I've been toying with the idea that the build should break if there > are > any broken links (at least internal links) in the .rst files.  Is > there > a practical way to make that happen? Any internal references (using the 'doc:' or 'ref:'

[ovs-dev] [PATCH 2/2] make: Add 'doc-check' target

2016-12-23 Thread Stephen Finucane
This does basic validation of the syntax and validates all external links. The nitpick ('-n') flag is added to ensure all possible warnings are raised. Signed-off-by: Stephen Finucane <step...@that.guru> Cc: Ben Pfaff <b...@ovn.org> --- Documentation/automake.mk | 7 ++- D

[ovs-dev] [PATCH 1/2] docs: Resolve broken URLs

2016-12-23 Thread Stephen Finucane
These were found using the 'linkcheck' builder. Signed-off-by: Stephen Finucane <step...@that.guru> Cc: Ben Pfaff <b...@ovn.org> --- Documentation/faq/openflow.rst | 2 +- Documentation/faq/vlan.rst | 4 ++-- Documentation/f

[ovs-dev] [RFC] make: Check for Sphinx before checking docs

2016-12-23 Thread Stephen Finucane
Signed-off-by: Stephen Finucane <step...@that.guru> --- I can't get this to work. I'm getting the following error message: Documentation/automake.mk:106: error: HAVE_SPHINX does not appear in AM_CONDITIONAL --- Documentation/automake.mk | 4 +++- m4/openvswitch.m4

[ovs-dev] [PATCH v2 3/6] doc: Document various language bindings

2016-12-22 Thread Stephen Finucane
Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk | 1 + Documentation/index.rst| 4 +- Documentation/topics/index.rst | 1 + Documentation/topics/language-bindings.rst | 60 ++ 4

[ovs-dev] [PATCH v2 1/6] doc: Add info on building documentation

2016-12-22 Thread Stephen Finucane
I know how to do this, but does anyone else? Let's make it obvious and ease the cognitive load on the great folks writing docs. Links to the various packaging guides, previously missing, are included on the main page. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documen

[ovs-dev] [PATCH v2 5/6] doc: Recommend compressed PNG images where possible

2016-12-22 Thread Stephen Finucane
ASCII images take up less space but are significantly less readable than proper images. Signed-off-by: Stephen Finucane <step...@that.guru> --- .../internals/contributing/documentation-style.rst| 15 --- 1 file changed, 12 insertions(+), 3 deletions(-) diff

[ovs-dev] [PATCH v2 2/6] doc: Misc fixes to 'bash-completion'

2016-12-22 Thread Stephen Finucane
Fix some minor formatting issues with this document. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/intro/install/bash-completion.rst | 27 ++--- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/Documentation/intro/instal

Re: [ovs-dev] [PATCH] docs: Add FAQ to the main page.

2016-12-22 Thread Stephen Finucane
On Thu, 2016-12-22 at 11:24 -0800, Joe Stringer wrote: > Signed-off-by: Joe Stringer <j...@ovn.org> /me tries to recall whether OVS uses Acked-by or Reviewed-by... Acked-by: Stephen Finucane <step...@that.guru> > --- >  Documentation/index.rst | 2 ++ >  1 file changed, 2

Re: [ovs-dev] [PATCH] Makefile: Fix name of coding style guide.

2017-03-30 Thread Stephen Finucane
e: Acked-By: Stephen Finucane <step...@that.guru> ___ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev

Re: [ovs-dev] [PATCH] INSTALL.rst: New file.

2017-03-30 Thread Stephen Finucane
gt; + > +b...@openvswitch.org > diff --git a/Makefile.am b/Makefile.am > index c853085b9ca9..6ad50b6af391 100644 > --- a/Makefile.am > +++ b/Makefile.am > @@ -67,6 +67,7 @@ EXTRA_DIST = \ >   AUTHORS.rst \ >   CONTRIBUTING.rst \ >   MAINTAINERS.rst \ > + INSTALL

Re: [ovs-dev] [PATCH] CONTRIBUTING.rst: Fix links.

2017-03-20 Thread Stephen Finucane
On Fri, 2017-03-17 at 11:27 -0700, Joe Stringer wrote: > Signed-off-by: Joe Stringer <j...@ovn.org> Acked-by: Stephen Finucane <step...@that.guru> ___ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev

Re: [ovs-dev] [RFC] Use tox to build docs.

2017-03-16 Thread Stephen Finucane
On Tue, 2017-03-14 at 10:50 -0400, Russell Bryant wrote: > On Tue, Mar 14, 2017 at 8:21 AM, Stephen Finucane <step...@that.guru> > wrote: > > On Mon, 2017-03-13 at 17:41 -0400, Russell Bryant wrote: > > > There have been a few patches lately tweaking docs to deal with &

Re: [ovs-dev] [PATCH 7/7] Documentation: Update DPDK doc with Keepalive feature.

2017-04-03 Thread Stephen Finucane
On Sat, 2017-04-01 at 20:02 +0100, Bhanuprakash Bodireddy wrote: > Signed-off-by: Bhanuprakash Bodireddy > Couple of changes suggested below if there's a future v2. Stephen > --- >  Documentation/howto/dpdk.rst | 95 >

Re: [ovs-dev] [PATCH] docs: Update version numbers in doc config.

2017-04-12 Thread Stephen Finucane
On Tue, 2017-04-11 at 13:15 -0400, Russell Bryant wrote: > Update the version numbers in the documentation config to reflect > 2.7.90 > instead of 2.6.0. > > This patch also updates the build system to automatically update this > file. > conf.py is now a generated file from conf.py.in.  We still

Re: [ovs-dev] [PATCH] docs: Update version numbers in doc config.

2017-04-12 Thread Stephen Finucane
On Wed, 2017-04-12 at 08:58 -0400, Russell Bryant wrote: > On Wed, Apr 12, 2017 at 7:29 AM, Stephen Finucane <step...@that.guru> > wrote: > > On Tue, 2017-04-11 at 13:15 -0400, Russell Bryant wrote: > > > Update the version numbers in the documentation config to reflect

[ovs-dev] [PATCH 1/2] doc: Describe how docs.openvswitch.org works

2017-04-06 Thread Stephen Finucane
Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/index.rst| 3 +- .../internals/contributing/documentation-style.rst | 6 ++ Documentation/internals/documentation.rst | 78 ++ Documentation/internals/ind

[ovs-dev] [PATCH 2/2] doc: Update makefile target for docs

2017-04-06 Thread Stephen Finucane
Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/intro/install/documentation.rst | 10 +- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Documentation/intro/install/documentation.rst b/Documentation/intro/install/documentation.rst index 1

  1   2   3   >