2
0
mirror of https://github.com/openvswitch/ovs synced 2025-08-30 05:47:55 +00:00

122 Commits

Author SHA1 Message Date
Alin Balutoiu
9943fbcc2b Python tests: Enable python tests on Windows
Updated the Readme with additional library required for
the python tests.

Remove the code which disable python tests to
be run on Windows.

Signed-off-by: Alin Balutoiu <abalutoiu@cloudbasesolutions.com>
Signed-off-by: Gurucharan Shetty <guru@ovn.org>
2017-01-03 13:04:25 -08:00
Joe Stringer
40c7b2fc0d lib: Add support for tftp ct helper.
The kernel datapath provides support for TFTP helpers, so add support
for this ALG to the commandline and OpenFlow encoding/decoding.

Signed-off-by: Joe Stringer <joe@ovn.org>
Acked-by: Daniele Di Proietto <diproiettod@vmware.com>
Acked-by: Ben Pfaff <blp@ovn.org>
2017-01-03 09:32:58 -08:00
Stephen Finucane
34aa9cf97e docs: Resolve broken URLs
These were found using the 'linkcheck' builder.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Cc: Ben Pfaff <blp@ovn.org>
Signed-off-by: Ben Pfaff <blp@ovn.org>
2016-12-23 16:11:46 -08:00
Stephen Finucane
95f2f97c60 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 <stephen@that.guru>
Fixes: b8d24cc8a ("doc: Misc Windows doc formatting fixes")
Signed-off-by: Ben Pfaff <blp@ovn.org>
2016-12-23 08:53:23 -08:00
Stephen Finucane
2eaf6a0855 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 <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
2016-12-22 10:15:51 -08:00
Stephen Finucane
ea0c5fd8ba doc: Misc fixes to 'bash-completion'
Fix some minor formatting issues with this document.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
2016-12-22 10:14:30 -08:00
Stephen Finucane
73c76b4470 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 <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
2016-12-22 10:14:28 -08:00
Hui Kang
4384c7f791 Update netbsd install doc
- test ovs on netbsd 7.0.2
- use gmake to compile and install

Signed-off-by: Hui Kang <hkang.sunysb@gmail.com>
Signed-off-by: Ben Pfaff <blp@ovn.org>
2016-12-21 15:26:58 -08:00
Lance Richardson
b4675b81a6 Documentation: fix some typos
s/deamon/daemon/
s/dependant/dependent/

Signed-off-by: Lance Richardson <lrichard@redhat.com>
Signed-off-by: Ben Pfaff <blp@ovn.org>
2016-12-21 15:06:17 -08:00
Stephen Finucane
569e3885c5 doc: Move testing to testing section
This makes more sense here, seeing as it's not exactly installation
related.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
2016-12-21 13:54:37 -08:00
Stephen Finucane
e69e4f5bac doc: Split dpdk, dpdk-advanced into multiple docs
Combined, the dpdk and dpdk-advanced installation documents provide a
lot of useful information, but most of this information is unrelated to
installation. Rework these documents, completely breaking up the
dpdk-advanced document into multiple smaller documents in other sections
and moving non-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 <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
2016-12-21 13:53:44 -08:00
Stephen Finucane
b8d24cc8a8 doc: Misc Windows doc formatting fixes
There are a couple of minor issues with this document:

- Some commands intended to be run in the MinGW shell are prefixed with
  '>', suggesting they are in fact PowerShell commands
- PowerShell syntax highlighting is not enabled
- Indentation is off for a couple of blocks

Resolve all of these through use of the 'code-block' element and a lot
of random fixes.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
2016-12-21 13:36:34 -08:00
Stephen Finucane
890ffc066f 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 <stephen@that.guru>
Fixes: a0c03adff6c2 ("Windows: document multiple NIC support setup")
Cc: Alin Gabriel Serdean <aserdean@cloudbasesolutions.com>
Signed-off-by: Ben Pfaff <blp@ovn.org>
2016-12-21 13:36:26 -08:00
Alin Serdean
a0c03adff6 Windows: document multiple NIC support setup
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 <aserdean@cloudbasesolutions.com>
Acked-by: Paul Boca <pboca@cloudbasesolutions.com>
Acked-by: Sairam Venugopal <vsairam@vmware.com>
Signed-off-by: Gurucharan Shetty <guru@ovn.org>
2016-12-20 12:23:19 -08:00
Joe Stringer
7532fefec4 docs: Document nc dependency for kernel tests.
Signed-off-by: Joe Stringer <joe@ovn.org>
Acked-by: Yi-Hung Wei <yihung.wei@gmail.com>
2016-12-20 10:55:49 -08:00
Stephen Finucane
5813d8103f doc: Fix a couple of broken links
I missed these while moving things around.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
2016-12-13 11:27:29 -08:00
Yi-Hung Wei
66e910cee5 doc: Add required packages for RHEL build dependency
Two more packages are needed to build ovs package on RHEL.

Signed-off-by: Yi-Hung Wei <yihung.wei@gmail.com>
[joe@ovn.org added fedora doc]
Signed-off-by: Joe Stringer <joe@ovn.org>
2016-12-12 11:00:46 -08:00
Stephen Finucane
11e029064c doc: Populate 'faq' section
This is mostly the exact same contents, albeit broken up into multiple
files.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
2016-12-12 08:58:14 -08:00
Stephen Finucane
3c8a3b312a 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 <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
2016-12-12 08:57:07 -08:00
Stephen Finucane
7c9afefd0a 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 <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
2016-12-12 08:57:06 -08:00
Stephen Finucane
795752a3cf 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 <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
2016-12-12 08:55:32 -08:00
Stephen Finucane
11820a1fc0 doc: Create directory structure
Create a series of sections, all of which are currently empty, using
the general design established by Jacob Kaplan-Moss and the Django
project [1]. Five sections are provided:

- intro
- tutorials
- topics
- howto
- ref
- faq
- internals

The purpose of each section is described in the documents themselves.

[1] https://jacobian.org/writing/great-documentation/

Signed-off-by: Stephen Finucane <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
2016-12-12 08:52:36 -08:00