This provides a location to include all testing-related aspects of
documentation.
Signed-off-by: Stephen Finucane
---
Documentation/index.rst| 2 +
Documentation/install-guide/dpdk.rst | 197 +---
Documentation/install-guide/general.rst| 348
Signed-off-by: Stephen Finucane
---
.../committer-grant-revocation.rst | 398 +
.../committer-responsibilities.rst | 96 +
Documentation/contributor-guide/index.rst | 34 ++
Documentation/index.rst
This is a top-level document, so plain old rST is preferred.
Signed-off-by: Stephen Finucane
---
This is the first time we completely replace a Markdown file with its
reStructuredText equivalent. How will this affect the 'dist-docs'
target?
---
Documentation/install-guide/general
documentation.
Signed-off-by: Stephen Finucane
---
Documentation/index.rst | 8 +-
Documentation/install-guide/dpdk.rst| 594 ++
Documentation/install-guide/general.rst | 870
Documentation/install-guide/index.rst | 34
This is essentially the output of 'sphinx-quickstart' but with parts of
the Makefile merged into the existing Makefile.am and a license added
to the index.rst file.
Signed-off-by: Stephen Finucane
---
I need to know who to assign copyright to. I've used "Open vSwitch
Develope
;d like to gauge interest before continuing with the
remainder. I'd also appreciate help from folks who would take a stab at
coverting docs so I don't have to do it all by myself.
Feel free to direct any questions at me.
Stephen Finucane (5):
Add initial sphinx configuration
doc: Add a &
On 2016-10-04 22:01, Ben Pfaff wrote:
On Sat, Oct 01, 2016 at 08:01:29PM +0100, Stephen Finucane wrote:
Since the move to GitHub, OVS has increasingly used Markdown for all
of
its documentation. This seems like a natural fit, given Markdown's low
overhead and support in the GitHub w
On 2016-10-05 00:32, Ben Pfaff wrote:
On Wed, Oct 05, 2016 at 09:25:11AM +0900, Joe Stringer wrote:
On 2 October 2016 at 04:01, Stephen Finucane
wrote:
> This is essentially the output of 'sphinx-quickstart' but with parts of
> the Makefile merged into the existing Makefile.
On 2016-10-05 17:29, Ben Pfaff wrote:
On Wed, Oct 05, 2016 at 10:05:50AM +, Stephen Finucane wrote:
[snip]
3) Rework docs into a series of guides
I see the following guides as being helpful
- Installation guide
- Usage guide
- Contributor guide
I had a 'testing-
We have one for coding and could do with one for docs.
Signed-off-by: Stephen Finucane
---
DocumentationStyle.rst | 274 +
1 file changed, 274 insertions(+)
create mode 100644 DocumentationStyle.rst
diff --git a/DocumentationStyle.rst b
Help documentation authors avoid common pitfalls.
Signed-off-by: Stephen Finucane
---
I imagine this could be contentious, which is why I included it
separately :)
---
DocumentationStyle.rst | 92 +++---
1 file changed, 80 insertions(+), 12 deletions
I'm going to dripfeed the conversion patches to avoid overloading
peoples (there are ~25 of them so far). This is the first batch.
Stephen Finucane (9):
dist-docs: Add support for rST
doc: Convert INSTALL to rST
doc: Convert INSTALL.DPDK to rST
doc: Convert INSTALL.Debian to rST
Signed-off-by: Stephen Finucane
---
INSTALL.Debian.md | 101 -
INSTALL.Debian.rst | 117
INSTALL.rst | 2 +-
Makefile.am | 2 +-
README.md | 4 +-
vtep
Signed-off-by: Stephen Finucane
---
INSTALL.XenServer.rst | 224 ++
INSTALL.rst | 2 +-
Makefile.am | 2 +-
README.md | 4 +-
4 files changed, 228 insertions(+), 4 deletions(-)
create mode 100644
cutils'), etc.
and can be installed from pip using the 'docsutils' package.
Signed-off-by: Stephen Finucane
---
Makefile.am | 4 ++--
build-aux/dist-docs | 22 +++---
2 files changed, 21 insertions(+), 5 deletions(-)
diff --git a/Makefile.am b/Makefil
Signed-off-by: Stephen Finucane
---
INSTALL.KVM.md | 87 --
INSTALL.KVM.rst | 99 +
Makefile.am | 2 +-
README.md | 4 +--
4 files changed, 102 insertions(+), 90 deletions
Signed-off-by: Stephen Finucane
---
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
Signed-off-by: Stephen Finucane
---
INSTALL.DPDK-ADVANCED.md | 2 +-
INSTALL.NetBSD.md| 4 +-
INSTALL.rst | 3 +-
INSTALL.userspace.md | 86
INSTALL.userspace.rst| 101
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
Signed-off-by: Stephen Finucane
---
INSTALL.Docker.md| 298 ---
INSTALL.Docker.rst | 320 +++
Makefile.am | 2 +-
README.md| 4 +-
tutorial/OVN-Tutorial.md | 2
Signed-off-by: Stephen Finucane
---
FAQ.md | 6 +-
INSTALL.DPDK-ADVANCED.md| 8 +-
INSTALL.DPDK.md | 625
INSTALL.DPDK.rst| 599 ++
INSTALL.rst
On 2016-10-12 20:20, Russell Bryant wrote:
On Sat, Oct 8, 2016 at 12:30 PM, Stephen Finucane
wrote:
I'm going to dripfeed the conversion patches to avoid overloading
peoples (there are ~25 of them so far). This is the first batch.
Stephen Finucane (9):
dist-docs: Add support for rS
On 2016-10-13 13:10, Russell Bryant wrote:
On Thu, Oct 13, 2016 at 6:00 AM, Stephen Finucane
wrote:
On 2016-10-12 20:20, Russell Bryant wrote:
On Sat, Oct 8, 2016 at 12:30 PM, Stephen Finucane
wrote:
I'm going to dripfeed the conversion patches to avoid overloading
peoples (there are ~
On 15 Oct 22:01, Russell Bryant wrote:
> On Sat, Oct 15, 2016 at 9:57 PM, Russell Bryant wrote:
>
> >
> > On Sat, Oct 8, 2016 at 12:30 PM, Stephen Finucane
> > wrote:
> >
> >> Signed-off-by: Stephen Finucane
> >> ---
> >> CONTRIBUTING.
On 15 Oct 21:20, Russell Bryant wrote:
> On Sat, Oct 8, 2016 at 12:30 PM, Stephen Finucane wrote:
>
> > This will eventually go away once Sphinx starts doing all this work for
> > us. For now, however, let's make sure we don't break the OVS website.
> >
> &
This is the second conversion series. This one is slightly larger, but
it covers all top-level documents that I've converted thus far. I'll
move onto those later this week.
There's also an unrelated patch which I noticed as I was typing this
cover letter. Feel free to ignore :)
S
Signed-off-by: Stephen Finucane
---
CONTRIBUTING.md | 4 +-
CodingStyle.md | 578 -
CodingStyle.rst | 642 +++
Makefile.am | 4 +-
OPENFLOW-1.1+.md | 6 +-
5 files changed, 649
Signed-off-by: Stephen Finucane
---
IntegrationGuide.md | 169 --
IntegrationGuide.rst| 195
Makefile.am | 2 +-
ovn/CONTAINERS.OpenStack.md | 4 +-
ovn/ovn-architecture.7.xml
Signed-off-by: Stephen Finucane
---
FAQ.md| 4 +-
INSTALL.NetBSD.md | 4 +-
Makefile.am | 2 +-
PORTING.md| 326 -
PORTING.rst | 330 ++
5 files changed
Signed-off-by: Stephen Finucane
---
MAINTAINERS.md | 29 --
MAINTAINERS.rst | 75 +
Makefile.am | 2 +-
3 files changed, 76 insertions(+), 30 deletions(-)
delete mode 100644 MAINTAINERS.md
create mode 100644
Signed-off-by: Stephen Finucane
---
INSTALL.rst | 2 +-
Makefile.am | 2 +-
README.md | 131
README.rst | 116 +++
rhel/openvswitch
Signed-off-by: Stephen Finucane
---
Makefile.am| 2 +-
REPORTING-BUGS.md | 58 ---
REPORTING-BUGS.rst | 73 ++
SECURITY.md| 2 +-
4 files changed, 75 insertions(+), 60 deletions
Signed-off-by: Stephen Finucane
---
FAQ.md | 4 +-
Makefile.am | 2 +-
WHY-OVS.md | 106 -
WHY-OVS.rst | 128
rhel/openvswitch
Signed-off-by: Stephen Finucane
---
Makefile.am | 2 +-
README-lisp.md | 81
README-lisp.rst | 113
3 files changed, 114 insertions(+), 82 deletions(-)
delete mode 100644 README-lisp.md
This is a top-level document, so plain old rST is preferred.
Signed-off-by: Stephen Finucane
---
Makefile.am | 2 +-
REPORTING-BUGS.rst | 2 +-
SECURITY.md => SECURITY.rst | 198 +---
3 files changed, 95 insertions(+),
Signed-off-by: Stephen Finucane
---
Makefile.am | 2 +-
README-native-tunneling.md | 85 ---
README-native-tunneling.rst | 176
debian/openvswitch-common.docs | 2 +-
ofproto/ofproto-tnl-unixctl.man | 2
Completely unrelated, but annoying. Let's fix it up.
Signed-off-by: Stephen Finucane
---
acinclude.m4 | 14 +++---
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/acinclude.m4 b/acinclude.m4
index 353519d..40d92ce 100644
--- a/acinclude.m4
+++ b/acinclude.m4
@@ -27,7
This is a top-level document, so plain old rST is preferred.
Signed-off-by: Stephen Finucane
---
DESIGN.md | 1093 -
DESIGN.rst | 1151 +++
Makefile.am |2
Rename it to OPENFLOW.
Signed-off-by: Stephen Finucane
---
FAQ.md | 4 +-
Makefile.am | 2 +-
OPENFLOW-1.1+.md | 317 --
OPENFLOW.rst | 415 +++
4 files changed, 418 insertions
Signed-off-by: Stephen Finucane
---
CONTRIBUTING.md | 414 --
CONTRIBUTING.rst| 444
Documentation/committer-responsibilities.md | 4 +-
Makefile.am
..
Reviewed-by: Stephen Finucane
___
dev mailing list
dev@openvswitch.org
http://openvswitch.org/mailman/listinfo/dev
On 2016-10-20 01:25, Russell Bryant wrote:
On Tue, Oct 18, 2016 at 4:03 PM, Stephen Finucane
wrote:
Signed-off-by: Stephen Finucane
---
CONTRIBUTING.md | 4 +-
CodingStyle.md | 578
-
CodingStyle.rst | 642
We're going to convert all docs to reStructuredText, so the "legacy
documents" warning is going to become outdated rather quickly. Simply
remove it.
Signed-off-by: Stephen Finucane
---
DocumentationStyle.rst | 10 --
1 file changed, 4 insertions(+), 6 deletions(-
On 2016-10-21 04:40, Mauricio Vasquez B wrote:
Signed-off-by: Mauricio Vasquez B
---
INSTALL.DPDK.rst | 148
+-
INSTALL.Debian.rst| 20 +--
INSTALL.Docker.rst| 76 +++---
INSTALL.KVM.rst | 24 ++-
On 2016-10-21 04:51, Mauricio Vasquez B wrote:
Previous fix was also wrong.
Fixes: 167703d ("doc: Convert INSTALL.DPDK to rST")
Signed-off-by: Mauricio Vasquez B
Drat - case sensitivity.
Acked-by: Stephen Finucane
...for the immediate fix, but maybe we should switch to a refere
On 28 Oct 15:45, Ciara Loftus wrote:
> 'dpdk' ports no longer have naming restrictions. Now, instead
> of specifying the dpdk port ID as part of the name, the PCI
> address of the device must be specified via the 'dpdk-devargs'
> option. eg.
>
> ovs-vsctl add-port br0 my-port
> ovs-vsctl set Inter
On 28 Oct 23:25, Russell Bryant wrote:
> On Tue, Oct 18, 2016 at 10:03 PM, Stephen Finucane
> wrote:
>
> > Signed-off-by: Stephen Finucane
> > ---
> > Makefile.am | 2 +-
> > README-native-tunneling.md | 85 ---
This is a top-level document, so plain old rST is preferred.
Signed-off-by: Stephen Finucane
---
v2:
- Split the OF message table into multiple tables
- Resolve some issues with table headers not displaying
---
DESIGN.md | 1093
quite this much documentation in the repo.
Stephen Finucane (23):
doc: Convert ovs-command-bashcomp.INSTALL to rST
doc: Convert committer-grant-revocation to rST
doc: Convert committer-responsibilities to rST
doc: Convert release-process to rST
doc: Convert OVSDB-replication to rST
doc: Convert r
Signed-off-by: Stephen Finucane
---
Documentation/automake.mk| 2 +-
Documentation/committer-grant-revocation.md | 356
Documentation/committer-grant-revocation.rst | 398 +++
MAINTAINERS.rst
Signed-off-by: Stephen Finucane
---
utilities/automake.mk | 4 +-
utilities/ovs-command-bashcomp.INSTALL.md | 88 ---
utilities/ovs-command-bashcomp.INSTALL.rst | 111 +
3 files changed, 113 insertions(+), 90 deletions
Signed-off-by: Stephen Finucane
---
Documentation/automake.mk | 2 +-
Documentation/release-process.md | 99
Documentation/release-process.rst | 117 ++
FAQ.rst | 2 +-
4 files changed
Signed-off-by: Stephen Finucane
---
Documentation/OVSDB-replication.md | 152 ---
Documentation/OVSDB-replication.rst | 172
Documentation/automake.mk | 2 +-
3 files changed, 173 insertions(+), 153 deletions
This is a top-level document, so plain old rST is preferred.
Signed-off-by: Stephen Finucane
---
INSTALL.Fedora.md | 2 +-
INSTALL.RHEL.md | 6 +-
rhel/README.RHEL| 267 ---
rhel/README.rst | 302
Expand on the definition of VTEP (it took me a bit of Googling).
Signed-off-by: Stephen Finucane
---
vtep/README.ovs-vtep.md | 205 -
vtep/README.ovs-vtep.rst | 231 +++
vtep/automake.mk | 2 +-
3
Signed-off-by: Stephen Finucane
---
INSTALL.Fedora.md | 130 ---
INSTALL.Fedora.rst | 144 +
INSTALL.RHEL.md| 4 +-
INSTALL.SELinux.md | 4 +-
INSTALL.rst| 2 +-
Makefile.am
Signed-off-by: Stephen Finucane
---
INSTALL.SSL.md | 314 -
INSTALL.SSL.rst | 338
Makefile.am | 2 +-
README.rst | 2 +-
rhel/openvswitch
Signed-off-by: Stephen Finucane
---
INSTALL.Libvirt.md | 72 -
INSTALL.Libvirt.rst | 93 +
Makefile.am | 2 +-
README.rst | 2 +-
4 files changed, 95 insertions(+), 74 deletions
Signed-off-by: Stephen Finucane
---
INSTALL.NetBSD.md | 38 -
INSTALL.NetBSD.rst | 62 ++
INSTALL.rst| 2 +-
Makefile.am| 2 +-
4 files changed, 64 insertions(+), 40 deletions(-)
delete mode
Signed-off-by: Stephen Finucane
---
Documentation/automake.mk| 2 +-
Documentation/committer-responsibilities.md | 78 --
Documentation/committer-responsibilities.rst | 96
MAINTAINERS.rst | 2
Refer to 'dnf' and not the deprecated 'yum'.
Signed-off-by: Stephen Finucane
---
INSTALL.SELinux.md | 173 ---
INSTALL.SELinux.rst | 174
Makefile.am | 2 +-
READM
This is already in rST (whut?), but we should add a license and make
the formatting a little more consistent.
Signed-off-by: Stephen Finucane
---
windows/README.rst | 72 +-
1 file changed, 50 insertions(+), 22 deletions(-)
diff --git a
Signed-off-by: Stephen Finucane
---
INSTALL.DPDK-ADVANCED.md | 898
INSTALL.DPDK-ADVANCED.rst | 938 ++
INSTALL.DPDK.rst | 10 +-
Makefile.am | 2 +-
4 files changed, 944
Signed-off-by: Stephen Finucane
---
xenserver/README | 186 --
xenserver/README.rst | 175 +++
xenserver/automake.mk | 2 +-
3 files changed, 176 insertions(+), 187 deletions(-)
delete mode
Signed-off-by: Stephen Finucane
---
third-party/README.md | 38
third-party/README.rst | 66 +
third-party/automake.mk | 2 +-
3 files changed, 67 insertions(+), 39 deletions(-)
delete mode 100644 third-party
Signed-off-by: Stephen Finucane
---
datapath-windows/CodingStyle | 154
datapath-windows/CodingStyle.rst | 183 +++
datapath-windows/automake.mk | 2 +-
3 files changed, 184 insertions(+), 155 deletions(-)
delete
Signed-off-by: Stephen Finucane
---
datapath-windows/{DESIGN => DESIGN.rst} | 503 ++--
datapath-windows/automake.mk| 2 +-
2 files changed, 279 insertions(+), 226 deletions(-)
rename datapath-windows/{DESIGN => DESIGN.rst} (54%)
diff --git a/da
Signed-off-by: Stephen Finucane
---
ovn/CONTAINERS.OpenStack.md | 122 --
ovn/CONTAINERS.OpenStack.rst | 135 +++
ovn/automake.mk | 2 +-
3 files changed, 136 insertions(+), 123 deletions(-)
delete mode
Signed-off-by: Stephen Finucane
---
lib/mac-learning.c | 3 +-
lib/mac-learning.h | 2 +-
vswitchd/INTERNALS | 239
vswitchd/INTERNALS.rst | 244 +
vswitchd/automake.mk | 2 +-
5
Signed-off-by: Stephen Finucane
---
ovn/{OVN-GW-HA.md => OVN-GW-HA.rst} | 309 +---
ovn/TODO| 2 +-
ovn/automake.mk | 2 +-
3 files changed, 182 insertions(+), 131 deletions(-)
rename ovn/{OVN-GW-HA.md =>
Signed-off-by: Stephen Finucane
---
INSTALL.Docker.rst | 2 +-
INSTALL.RHEL.md| 171 ---
INSTALL.RHEL.rst | 208 +
INSTALL.rst| 2 +-
Makefile.am| 2 +-
README.rst
Signed-off-by: Stephen Finucane
---
datapath/Modules.mk | 2 +-
datapath/README.md | 265 ---
datapath/README.rst | 265 +++
lib/dpif.h | 2 +-
vtep/README.ovs-vtep.rst | 2
On 2016-11-02 17:57, Joe Stringer wrote:
On 30 October 2016 at 06:29, Stephen Finucane
wrote:
This is the third conversion series. This one is larger yet again,
though many of the docs are rather small. After this series, only the
two tutorial docs in 'tutorial' require conversion (
On 2016-11-04 00:43, Russell Bryant wrote:
On Sun, Oct 30, 2016 at 2:30 PM, Stephen Finucane
wrote:
Signed-off-by: Stephen Finucane
---
lib/mac-learning.c | 3 +-
lib/mac-learning.h | 2 +-
vswitchd/INTERNALS | 239
vswitchd
tive links, and OVS
evolves too fast to rely on non-breaking links to GitHub. Better to
rely on shell examples like we do elsewhere and let the user figure it
out.
Signed-off-by: Stephen Finucane
---
tutorial/automake.mk | 2 +-
tutorial/{OVN-Tutorial.md => ovn-tutori
This is the fourth and final conversion series. This was kept separate
due to the size and complexity of the tutorial guides. There are also
ancillary changes to a previously unformatted TODO file (missed
previously due to the lack of an extension) and the AUTHORS file.
Stephen Finucane (4
This might not be of much value, but let's be consistent where we can.
Signed-off-by: Stephen Finucane
---
ovn/TODO | 213 --
ovn/TODO.rst | 233 +++
2 files changed, 233 inser
Signed-off-by: Stephen Finucane
---
FAQ.rst | 2 +-
README.rst | 2 +-
tutorial/OVN-Tutorial.md | 2 +-
tutorial/Tutorial.md | 859 --
tutorial/automake.mk | 2 +-
tutorial/tutorial.rst| 870
On 2016-11-04 15:28, Russell Bryant wrote:
On Fri, Nov 4, 2016 at 11:03 AM, Stephen Finucane
wrote:
This is the fourth and final conversion series. This was kept
separate
due to the size and complexity of the tutorial guides. There are
also
ancillary changes to a previously unformatted TODO
There is some debug "logging" code included in the 'ovs_client'
application. This code appears to be broken as it spams stdout with
duplicated "log" messages. Remove this code.
In addition, add the 'ovsclient' executable to the 'tests/.gitignore'
low longer file
names and other niceties. It's use is an option in Automake 1.9+.
Enable this option.
Signed-off-by: Stephen Finucane
Reviewed-by: Mark D. Gray
---
configure.ac |2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/configure.ac b/configure.ac
index
allow longer file
names and other niceties. Its use is a configuration option in Automake
1.9+. Enable this option.
Signed-off-by: Stephen Finucane
Reviewed-by: Mark D. Gray
Cc: Panu Matilainen
---
configure.ac |2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/configu
This provides a quick, easy way to use the 'mdl' executable provided
in markdowlinter to validate documentation.
This change does not resolve any of the issues this linter raises -
these will need to be done in a follow up patch.
Signed-off-by: Stephen Finucane
---
INSTA
83 matches
Mail list logo
