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

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?

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

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

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

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

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

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

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

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

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

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

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

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

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 07/11] doc: Populate 'topics' section

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

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 09/11] doc: Move WHY-OVS

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

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

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

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

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

-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

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

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

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.

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

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

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

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

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 1/5] doc: Use higher resolution logo

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 4/4] Merge docs into README

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.

+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

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

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

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

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

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

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

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

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

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

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'

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

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

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

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] build: fix rpm-fedora target breakage

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.

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.

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

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

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

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

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

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

+. 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 ':'

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.

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

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

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 v2 4/5] make: Ensure flake8, sphinx run when required

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

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

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

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

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

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

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

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

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

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

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

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

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'

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.

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.

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.

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.

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.

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] docs: Update version numbers in doc config.

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.

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

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

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

[ovs-dev] [RFC 1/4] doc: Add man page section to documentation guide

We also replace 'reST' with the far more common 'rST'. Signed-off-by: Stephen Finucane <step...@that.guru> --- .../internals/contributing/documentation-style.rst | 84 +++--- 1 file changed, 76 insertions(+), 8 deletions(-) diff --git a/Documentation/internals/contri

[ovs-dev] [RFC 3/4] doc: Convert ovs-test to rST

Signed-off-by: Stephen Finucane <step...@that.guru> --- See comment on the previous change --- Documentation/automake.mk | 2 + Documentation/conf.py | 3 + Documentation/ref/index.rst | 1 + Documentation/ref/ovs-test.rst

[ovs-dev] [RFC 2/4] doc: Convert ovs-vlan-test to rST

ction character". Other than that, hurrah for (mostly) legible syntaxes. [1] http://www.tldp.org/HOWTO/Man-Page/q2.html Signed-off-by: Stephen Finucane <step...@that.guru> --- I don't know if this is correctly integrated into the docs build system or not. I need someone to double check

[ovs-dev] [RFC 4/4] doc: Remove latex output configuration

We don't care about building LaTeX documentation, so there's no need to keep this build cruft around. Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/automake.mk | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/Documentation/automake.mk b/Documen

[ovs-dev] [RFC 0/4] Introduce Sphinx for man pages

this months ago, but I completely forgot about it. It's unfinished, as evidenced by the commit footers. However, I think with a little help from the maintainers of the packaging in OVS, it will be easy push this over the line and move onto the bigger, more important man pages. Stephen Finucane (4

Re: [ovs-dev] [PATCH] doc: Link to release FAQ from DPDK install guide

On Fri, 2017-04-07 at 15:28 +, Darrell Ball wrote: > > On 4/7/17, 6:58 AM, "ovs-dev-boun...@openvswitch.org on behalf of > Stephen Finucane" <ovs-dev-boun...@openvswitch.org on behalf of steph > e...@that.guru> wrote: > > I wanted to find the mapping

[ovs-dev] [PATCH v2] doc: Link to release FAQ from DPDK install guide

I wanted to find the mappings of DPDK versions to OVS versions. This was a little more difficult than expected. Resolve the issue by linking to it from the DPDK install guide. Signed-off-by: Stephen Finucane <step...@that.guru> --- v2: - Add a link to the releases FAQ from the instal

Re: [ovs-dev] [PATCH ovs V2] Documentation: fix broken links in maintainers page

n/latest/internals/committer- responsibilities.rst>`__ or, cleaner: `here`__ __ http://docs.openvswitch.org/en/latest/internals/committer-responsi bilities.rst I should have mentioned this before but I didn't think of it . Thi s can be fixed at merge time though, so for this as-is: Acked

Re: [ovs-dev] [PATCH] docs: Automatically extract version from NEWS

On Thu, 2017-04-13 at 11:22 -0700, Ben Pfaff wrote: > On Wed, Apr 12, 2017 at 12:32:24PM +0100, Stephen Finucane wrote: > > Parse the version and release from the NEWS file. This looks a bit > > hacky, but the NEWS file is generally well formatted and should be > > reliable en

Re: [ovs-dev] [branch-2.7] Documentation: Remove external dependence on pygments.

On Wed, 2017-04-19 at 08:12 -0700, Ben Pfaff wrote: > On Wed, Apr 19, 2017 at 12:23:39PM +0100, Stephen Finucane wrote: > > From: Ilya Maximets <i.maxim...@samsung.com> > > > > Current documentation uses syntax highlighting in 'sphinx' > > via 'pygments' libr

Re: [ovs-dev] [PATCH ovs] Documentation: fix broken links in maintainers page

On Tue, 2017-04-18 at 15:08 +0300, Roi Dayan wrote: > The links were pointing to static non-existent location instead > of internal doc link. > > Signed-off-by: Roi Dayan > --- >  MAINTAINERS.rst | 4 ++-- >  1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git

Re: [ovs-dev] [PATCH] Documentation: Remove external dependence on pygments.

On Wed, 2017-04-19 at 12:21 +0100, Stephen Finucane wrote: > From: Ilya Maximets <i.maxim...@samsung.com> > > Current documentation uses syntax highlighting in 'sphinx' > via 'pygments' library. This leads to build failures on the > systems with old version of this library. &

Re: [ovs-dev] problem in "make" for openvswitch-2.7.0

On Wed, 2017-04-19 at 12:16 +0100, rihab isims wrote: > Hi, > > I am following the installation guide to install openvswitch-2.7.0 > from > this link http://docs.openvswitch.org/en/latest/intro/install/general > / > however i am blocked at "make" command execution with the following > error: > >

[ovs-dev] [PATCH] Documentation: Remove external dependence on pygments.

From: Ilya Maximets Current documentation uses syntax highlighting in 'sphinx' via 'pygments' library. This leads to build failures on the systems with old version of this library. In fact that only 'windows.rst' uses highlighting it's a very simple change. This helps us

[ovs-dev] [branch-2.7] Documentation: Remove external dependence on pygments.

From: Ilya Maximets Current documentation uses syntax highlighting in 'sphinx' via 'pygments' library. This leads to build failures on the systems with old version of this library. In fact that only 'windows.rst' uses highlighting it's a very simple change. This helps us

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

On Mon, 2017-03-13 at 17:41 -0400, Russell Bryant wrote: > There have been a few patches lately tweaking docs to deal with > different > sphinx versions in different linux distributions.  This patch > demonstrates > an alternative approach to avoid those types of issues.  Instead of > calling >

Re: [ovs-dev] [patch_v1] doc: Support building ovs with Trusty.

On Tue, 2017-03-07 at 08:21 -0500, Russell Bryant wrote: > > > On Tue, Mar 7, 2017 at 5:31 AM, Stephen Finucane <step...@that.guru> > wrote: > > On Thu, 2017-03-02 at 20:01 -0800, Darrell Ball wrote: > > > Some code-block directives are not understood using >

Re: [ovs-dev] [PATCH RFC] doc: Decrease build requirements to support RHEL7.

one that you seem to have missed (documentation-style.rst)? As such, we only need the modifications to 'conf.py', 'openvswitch.m4' and 'requirements.txt'. Assuming we keep just those changes: Acked-by: Stephen Finucane <step...@that.guru> Stephen [1] https://patchwork.ozlabs.org/patch/734930/

Re: [ovs-dev] [PATCH 1/3] doc: Fix issues.rst formatting typo.

ech> LGTM. Acked-by: Stephen Finucane <step...@that.guru> ___ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev

  1   2   >