summaryrefslogtreecommitdiff
path: root/Documentation/automake.mk
Commit message (Collapse)AuthorAgeFilesLines
* xenserver: Remove xenserver.Greg Rose2022-08-151-1/+0
| | | | | | | | | | | | | Remove the current xenserver implementation - it is obsolete and since 3.0 we do not support kernel module builds [1]. 1. https://mail.openvswitch.org/pipermail/ovs-dev/2022-July/395789.html [i.maximets] Can be added back if people willing to maintain it will be found. Signed-off-by: Greg Rose <gvrose8192@gmail.com> Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
* doc: Add meter offload topic documentJianbo Liu2022-07-111-0/+1
| | | | | | | | For now, add introduction and the limitation of meter offload. Signed-off-by: Jianbo Liu <jianbol@nvidia.com> Acked-by: Eelco Chaudron <echaudro@redhat.com> Signed-off-by: Simon Horman <simon.horman@corigine.com>
* Documentation: Add USDT documentation and bpftrace example.Eelco Chaudron2022-01-181-0/+1
| | | | | | | | | Add the USDT documentation and a bpftrace example using the bridge run USDT probes. Signed-off-by: Eelco Chaudron <echaudro@redhat.com> Acked-by: Paolo Valerio <pvalerio@redhat.com> Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
* dpif-netdev: Introduce hash-based Tx packet steering mode.Maxime Coquelin2022-01-171-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch adds a new hash Tx steering mode that distributes the traffic on all the Tx queues, whatever the number of PMD threads. It would be useful for guests expecting traffic to be distributed on all the vCPUs. The idea here is to re-use the 5-tuple hash of the packets, already computed to build the flows batches (and so it does not provide flexibility on which fields are part of the hash). There are also no user-configurable indirection table, given the feature is transparent to the guest. The queue selection is just a modulo operation between the packet hash and the number of Tx queues. There are no (at least intentionnally) functionnal changes for the existing XPS and static modes. There should not be noticeable performance changes for these modes (only one more branch in the hot path). For the hash mode, performance could be impacted due to locking when multiple PMD threads are in use (same as XPS mode) and also because of the second level of batching. Regarding the batching, the existing Tx port output_pkts is not modified. It means that at maximum, NETDEV_MAX_BURST can be batched for all the Tx queues. A second level of batching is done in dp_netdev_pmd_flush_output_on_port(), only for this hash mode. Signed-off-by: Maxime Coquelin <maxime.coquelin@redhat.com> Reviewed-by: David Marchand <david.marchand@redhat.com> Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
* ovs-actions: Convert man page from xml to rST.Ilya Maximets2021-08-311-0/+1
| | | | | | | | | | | | | | | | | | | | | | This way it's easier to show it on a website as it will be updated automatically along with the rest of the documentation. Sphinx doesn't render everything perfectly, but it looks good enough in both man and html versions. rST is a bit easier to read and it takes less space. Conversion performed manually since I didn't found any good tool that can actually make the process any faster. Along the way I replaced versions like x.y.90 with x.y+1, because it doesn't seem correct to me to refer non-released versions of OVS in the docs. Fixed a couple of small mistakes like duplicated paragraph and reference to a different section by incorrect name. Also removed bits of xml->nroff conversion code that is not needed anymore. Signed-off-by: Ilya Maximets <i.maximets@ovn.org> Acked-by: Roi Dayan <roid@nvidia.com>
* docs: Add documentation for ovsdb relay mode.Ilya Maximets2021-07-151-0/+1
| | | | | | | | | Main documentation for the service model and tutorial with the use case and configuration examples. Acked-by: Mark D. Gray <mark.d.gray@redhat.com> Acked-by: Dumitru Ceara <dceara@redhat.com> Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
* docs: Add a topic about record/replay with ovsdb-server.Ilya Maximets2021-06-071-0/+1
| | | | | | | Also added a NEWS entry. Signed-off-by: Ilya Maximets <i.maximets@ovn.org> Acked-by: Dumitru Ceara <dceara@redhat.com>
* doc: automake: Add support for sphinx 4.0.Ilya Maximets2021-05-111-2/+7
| | | | | | | | | | | | | | | | | | | | File layout for man pages in sphinx 4 by default changed [1] from: Documentation/_ref/man/page.section to: Documentation/_ref/man/section/page.section Ajusting our build scripts so they will be able to locate files in new places. This fixes our CI build. [1] https://github.com/sphinx-doc/sphinx/issues/7996 Signed-off-by: Ilya Maximets <i.maximets@ovn.org> Acked-by: Ben Pfaff <blp@ovn.org> Reviewed-by: David Marchand <david.marchand@redhat.com> Reviewed-by: Aaron Conole <aconole@redhat.com>
* tunnel: Bareudp Tunnel Support.Martin Varghese2020-12-221-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There are various L3 encapsulation standards using UDP being discussed to leverage the UDP based load balancing capability of different networks. MPLSoUDP (__ https://tools.ietf.org/html/rfc7510) is one among them. The Bareudp tunnel provides a generic L3 encapsulation support for tunnelling different L3 protocols like MPLS, IP, NSH etc. inside a UDP tunnel. An example to create bareudp device to tunnel MPLS traffic is given $ ovs-vsctl add-port br_mpls udp_port -- set interface udp_port \ type=bareudp options:remote_ip=2.1.1.3 options:local_ip=2.1.1.2 \ options:payload_type=0x8847 options:dst_port=6635 The bareudp device supports special handling for MPLS & IP as they can have multiple ethertypes. MPLS procotcol can have ethertypes ETH_P_MPLS_UC (unicast) & ETH_P_MPLS_MC (multicast). IP protocol can have ethertypes ETH_P_IP (v4) & ETH_P_IPV6 (v6). The bareudp device to tunnel L3 traffic with multiple ethertypes (MPLS & IP) can be created by passing the L3 protocol name as string in the field payload_type. An example to create bareudp device to tunnel MPLS unicast & multicast traffic is given below.:: $ ovs-vsctl add-port br_mpls udp_port -- set interface udp_port \ type=bareudp options:remote_ip=2.1.1.3 options:local_ip=2.1.1.2 \ options:payload_type=mpls options:dst_port=6635 Signed-off-by: Martin Varghese <martin.varghese@nokia.com> Acked-By: Greg Rose <gvrose8192@gmail.com> Tested-by: Greg Rose <gvrose8192@gmail.com> Acked-by: Eelco Chaudron <echaudro@redhat.com> Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
* netdev-dpdk: Remove deprecated ring port type.Ilya Maximets2020-03-061-1/+0
| | | | | | | | | | | | | 'dpdkr' ring ports was deprecated in 2.13 release and was not actually used for a long time. Remove support now. More details in commit b4c5f00c339b ("netdev-dpdk: Deprecate ring ports.") Acked-by: Aaron Conole <aconole@redhat.com> Acked-by: David Marchand <david.marchand@redhat.com> Acked-by: Ian Stokes <ian.stokes@intel.com> Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
* dpdk: Remove deprecated pdump support.Ilya Maximets2020-03-061-1/+0
| | | | | | | | | | | | DPDK pdump was deprecated in 2.13 release and didn't actually work since 2.11. Removing it. More details in commit 4ae8c4617fd3 ("dpdk: Deprecate pdump support.") Acked-by: Aaron Conole <aconole@redhat.com> Acked-by: David Marchand <david.marchand@redhat.com> Acked-by: Ian Stokes <ian.stokes@intel.com> Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
* userspace: Add TCP Segmentation Offload supportFlavio Leitner2020-01-171-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | Abbreviated as TSO, TCP Segmentation Offload is a feature which enables the network stack to delegate the TCP segmentation to the NIC reducing the per packet CPU overhead. A guest using vhostuser interface with TSO enabled can send TCP packets much bigger than the MTU, which saves CPU cycles normally used to break the packets down to MTU size and to calculate checksums. It also saves CPU cycles used to parse multiple packets/headers during the packet processing inside virtual switch. If the destination of the packet is another guest in the same host, then the same big packet can be sent through a vhostuser interface skipping the segmentation completely. However, if the destination is not local, the NIC hardware is instructed to do the TCP segmentation and checksum calculation. It is recommended to check if NIC hardware supports TSO before enabling the feature, which is off by default. For additional information please check the tso.rst document. Signed-off-by: Flavio Leitner <fbl@sysclose.org> Tested-by: Ciara Loftus <ciara.loftus.intel.com> Signed-off-by: Ian Stokes <ian.stokes@intel.com>
* Documentation: Convert multiple manpages to ReST.Ben Pfaff2019-12-021-0/+7
| | | | | | Tested-by: Numan Siddique <numans@ovn.org> Acked-by: Numan Siddique <numans@ovn.org> Signed-off-by: Ben Pfaff <blp@ovn.org>
* doc: Added OVS Extensions documentAshish Varma2019-10-041-0/+1
| | | | | | | | | OVS supports OVS Extensions as various vendor messages or as vendor types in stats or multipart messages. Added a document to describe the extensions as currently supported by OVS. Signed-off-by: Ashish Varma <ashishvarma.ovs@gmail.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
* Documentation: Work with sphinx-build for Python 3 also.Ben Pfaff2019-09-201-1/+0
| | | | | | | | | | | There's nothing in OVS specific to Sphinx for Python 2, but the compile-time check only looked for a binary named "sphinx-build", which is typically provided only for Python 2. With Python 3, the binary is typically called "sphinx-build-3". With this commit, either name is accepted. Acked-by: Numan Siddique <nusididq@redhat.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
* Remove OVN.Mark Michelson2019-09-061-12/+0
| | | | | | | | | | | | | | | | OVN is separated into its own repo. This commit removes the OVN source, OVN tests, and OVN documentation. It also removes mentions of OVN from most documentation. The only place where OVN has been left is in changelogs/NEWS, since we shouldn't mess with the history of the project. There is an exception here. The ovsdb-cluster tests rely on ovn-nbctl and ovn-sbctl to run. Therefore those ovn utilities, as well as their dependencies remain in the repo with this commit. Acked-by: Numan Siddique <nusiddiq@redhat.com> Signed-off-by: Mark Michelson <mmichels@redhat.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
* netdev-afxdp: add new netdev type for AF_XDP.William Tu2019-07-191-0/+1
| | | | | | | | | | | | | | | | The patch introduces experimental AF_XDP support for OVS netdev. AF_XDP, the Address Family of the eXpress Data Path, is a new Linux socket type built upon the eBPF and XDP technology. It is aims to have comparable performance to DPDK but cooperate better with existing kernel's networking stack. An AF_XDP socket receives and sends packets from an eBPF/XDP program attached to the netdev, by-passing a couple of Linux kernel's subsystems As a result, AF_XDP socket shows much better performance than AF_PACKET For more details about AF_XDP, please see linux kernel's Documentation/networking/af_xdp.rst. Note that by default, this feature is not compiled in. Signed-off-by: William Tu <u9012063@gmail.com> Signed-off-by: Ilya Maximets <i.maximets@samsung.com>
* ossfuzz: Add documentationBhargava Shastry2019-07-031-0/+5
| | | | | | | | | | Documents OvS fuzzing effort and performs a rudimentary security analysis of existing OvS fuzzing harnesses. Feedback on the documentation and analysis appreciated. Signed-off-by: Bhargava Shastry <bshas3@gmail.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
* Documentation: OVN RBAC and IPsec tutorialQiuyu Xiao2018-11-091-0/+2
| | | | | | | | This patch adds step-by-step guide for configuring OVN Role-Based Access Control and IPsec. Signed-off-by: Qiuyu Xiao <qiuyu.xiao.qyx@gmail.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
* Documentation: IPsec tunnel tutorial and documentation.Qiuyu Xiao2018-11-091-0/+2
| | | | | | | | | | | | | tutorials/index.rst gives a step-by-setp guide to set up OVS IPsec tunnel. tutorials/ipsec.rst gives detailed explanation on the IPsec tunnel configuration methods and forwarding modes. Signed-off-by: Qiuyu Xiao <qiuyu.xiao.qyx@gmail.com> Signed-off-by: Ansis Atteka <aatteka@ovn.org> Co-authored-by: Ansis Atteka <aatteka@ovn.org> Signed-off-by: Ben Pfaff <blp@ovn.org>
* dpdk: Support both shared and per port mempools.Ian Stokes2018-07-061-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit re-introduces the concept of shared mempools as the default memory model for DPDK devices. Per port mempools are still available but must be enabled explicitly by a user. OVS previously used a shared mempool model for ports with the same MTU and socket configuration. This was replaced by a per port mempool model to address issues flagged by users such as: https://mail.openvswitch.org/pipermail/ovs-discuss/2016-September/042560.html However the per port model potentially requires an increase in memory resource requirements to support the same number of ports and configuration as the shared port model. This is considered a blocking factor for current deployments of OVS when upgrading to future OVS releases as a user may have to redimension memory for the same deployment configuration. This may not be possible for users. This commit resolves the issue by re-introducing shared mempools as the default memory behaviour in OVS DPDK but also refactors the memory configuration code to allow for per port mempools. This patch adds a new global config option, per-port-memory, that controls the enablement of per port mempools for DPDK devices. ovs-vsctl set Open_vSwitch . other_config:per-port-memory=true This value defaults to false; to enable per port memory support, this field should be set to true when setting other global parameters on init (such as "dpdk-socket-mem", for example). Changing the value at runtime is not supported, and requires restarting the vswitch daemon. The mempool sweep functionality is also replaced with the sweep functionality from OVS 2.9 found in commits c77f692 (netdev-dpdk: Free mempool only when no in-use mbufs.) a7fb0a4 (netdev-dpdk: Add mempool reuse/free debug.) A new document to discuss the specifics of the memory models and example memory requirement calculations is also added. Signed-off-by: Ian Stokes <ian.stokes@intel.com> Acked-by: Kevin Traynor <ktraynor@redhat.com> Acked-by: Tiago Lam <tiago.lam@intel.com> Tested-by: Tiago Lam <tiago.lam@intel.com>
* ovs-sim: Don't install manpage at all (except from ovs-sim itself).Ben Pfaff2018-06-181-4/+8
| | | | | | | | | | | | | | ovs-sim is a funny utility since it only works from a build tree, not from an installed OVS. That means that we shouldn't install its manpage when we run "make install". But we do want to install the manpage when we're inside ovs-sim itself, so that the user can invoke "man ovs-sim" from its nested shell. This commit makes this happen. Suggested-by: Roi Dayan <roid@mellanox.com> Signed-off-by: Ben Pfaff <blp@ovn.org> Acked-by: Roi Dayan <roid@mellanox.com>
* ovs-sim: Convert documentation to RST format.Ben Pfaff2018-05-251-1/+2
| | | | | Signed-off-by: Ben Pfaff <blp@ovn.org> Acked-by: Justin Pettit <jpettit@ovn.org>
* faq: Start an OVN FAQ by giving a rationale for how it uses tunnels.Ben Pfaff2018-05-101-0/+1
| | | | | Signed-off-by: Ben Pfaff <blp@ovn.org> Acked-by: Aaron Conole <aconole@redhat.com>
* doc: Add "jumbo frames" topic documentStephen Finucane2018-04-211-0/+1
| | | | | | | We include references from the physical and vhost-user interface guides. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ian Stokes <ian.stokes@intel.com>
* doc: Move "pdump" guide to its own documentStephen Finucane2018-04-211-0/+1
| | | | | | | | Yet another section that's far too detailed for someone getting started with DPDK in OVS. Split it out. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ian Stokes <ian.stokes@intel.com>
* doc: Add "bridge" topic documentStephen Finucane2018-04-211-0/+1
| | | | | | | | This details configuration steps that apply to the entire bridge, rather than individual ports. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ian Stokes <ian.stokes@intel.com>
* doc: Move "QoS" guide to its own documentStephen Finucane2018-04-211-0/+1
| | | | | | | Again, this stuff is too detailed for a high-level howto. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ian Stokes <ian.stokes@intel.com>
* doc: Add "vdev" topic documentStephen Finucane2018-04-211-0/+1
| | | | | | | | | These are separate things from physical, ring and vhost-user interfaces and deserve their own documents. A couple of small typos are fixed along the way. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ian Stokes <ian.stokes@intel.com>
* doc: Add "PMD" topic documentStephen Finucane2018-04-211-0/+1
| | | | | | | | | | This continues the breakup of the huge DPDK "howto" into smaller components. There are a couple of related changes included, such as using "Rx queue" instead of "rxq" and noting how Tx queues cannot be configured. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ian Stokes <ian.stokes@intel.com>
* doc: Add an overview of the 'dpdk' portStephen Finucane2018-04-211-0/+1
| | | | | | | | | | | | | | | | | These ports are used to allow ingress/egress from the host and are therefore _reasonably_ important. However, there is no clear overview of what these ports actually are or why things are done the way they are. Start closing this gap by providing a standalone example of using these ports along with a little more detailed overview of the binding process. There is additional cleanup to be done for the DPDK howto, but that will be done separately. We enable the TODO directive so we can actually start calling out some TODOs. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ian Stokes <ian.stokes@intel.com>
* netns: Add documentation and update NEWS.Flavio Leitner2018-04-131-0/+1
| | | | | | | | Create a document to describe the how it works and known limitations and update the NEWS accordingly. Signed-off-by: Flavio Leitner <fbl@sysclose.org> Signed-off-by: Ben Pfaff <blp@ovn.org>
* doc: Added OVS Conntrack tutorialAshish Varma2018-02-011-0/+1
| | | | | | | | | OVS supports connection tracker related match fields and actions. Added a tutorial to demonstrate the basic use cases for some of these match fields and actions. Signed-off-by: Ashish Varma <ashishvarma.ovs@gmail.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
* ovsdb: Improve documentation.Ben Pfaff2017-12-141-1/+4
| | | | | Signed-off-by: Ben Pfaff <blp@ovn.org> Acked-by: Justin Pettit <jpettit@ovn.org>
* ovn: Add document describing new features in OVN added in version 2.8.Ben Pfaff2017-11-131-0/+1
| | | | | | | | This is adapted from a talk I gave at OpenStack Summit Sydney on Nov. 6. Signed-off-by: Ben Pfaff <blp@ovn.org> Acked-by: Mark Michelson <mmichels@redhat.com> Acked-by: Miguel Angel Ajo <majopela@redhat.com>
* Documentation: Add the Open vSwitch project charter.Ben Pfaff2017-11-021-0/+1
| | | | | | | | It always seems odd that this isn't in the repo, so this adds it, with internal links properly directed. Signed-off-by: Ben Pfaff <blp@ovn.org> Acked-by: Mark Michelson <mmichels@redhat.com>
* Introduce Emeritus Committer status.Russell Bryant2017-10-271-0/+1
| | | | | | | | | | | | | | | | | | | | | | | This patch introduces an Emeritus status for OVS committers. An Emeritus Committer is recognized as having made a significant impact to the project and having been a committer in the past. It is intended as an option for those that do not currently have the time or interest to fulfill committer responsibilities based on their current responsibilities. While in this status, they are not included in voting for governance purposes. An emeritus committer may be re-instated as a full committer at any time. The OVS committers voted approval of this change. See documentation contents for full details. Suggested-by: Ethan J. Jackson <ejj@eecs.berkeley.edu> Acked-by: Justin Pettit <jpettit@ovn.org> Acked-by: Ethan J. Jackson <ethan@kelda.io> Signed-off-by: Russell Bryant <russell@ovn.org> Signed-off-by: Ben Pfaff <blp@ovn.org>
* Documentation: Add document describing RBACMark Michelson2017-10-241-0/+1
| | | | | | | | | | | | | Role based access control is a relatively new addition to OVS/OVN, and aside from the database documentation in ovn-sb(5), there is not much explaining what RBAC is, how to use it, and the available roles. This document remedies that situation. It is hopeful that any new roles added will be added to this document in the future. Signed-off-by: Mark Michelson <mmichels@redhat.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
* OVN: Document how to use firewalld service filesMark Michelson2017-10-241-0/+1
| | | | | | | | | Firewalld service files for OVN have been in the source for several months. This adds instructions for how to use these service files with firewalld. Signed-off-by: Mark Michelson <mmichels@redhat.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
* Documentation: Add Faucet tutorial.Ben Pfaff2017-10-241-0/+1
| | | | | | | This is for a talk at the Faucet conference on Oct. 19: http://conference.faucet.nz/schedule/ Signed-off-by: Ben Pfaff <blp@ovn.org>
* Documentation: Also define install-man-rst when Sphinx is not available.Ben Pfaff2017-09-251-1/+4
| | | | | | | | | | "make sandbox" wants to install the ReST manpages, but it failed when Sphinx wasn't available. This fixes the problem. Fixes: 986311be550e ("ovs-sandbox: Install .rst manpages into the sandbox as well.") Reported-by: Justin Pettit <jpettit@ovn.org> Signed-off-by: Ben Pfaff <blp@ovn.org> Acked-by: Justin Pettit <jpettit@ovn.org>
* ovsdb-idl: compound indexes design documentLance Richardson2017-08-031-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | In the work made in our projects, it was found the need to have a faster access to the rows contained in tables in the replica, as well to have the possibility to loop over a subset of rows that meet some specified criteria. Those needs lead us to design and implement a functionality that satisfies those requirements, so an implementation of special indexes were done. In order to keep the OVSDB server implementation unmodified and avoid extra load of processing, the indexes are created as part of the IDL. The indexes are created as part of the initialization of the replica request and are maintained automatically when there are changes in the replica. This document explains the design rationale of the compound indexes feature. Signed-off-by: Javier Albornoz <javier.albornoz@hpe.com> Signed-off-by: Esteban Rodriguez Betancourt <estebarb@hpe.com> Signed-off-by: Jorge Arturo Sauma Vargas <jorge.sauma@hpe.com> Co-authored-by: Javier Albornoz <javier.albornoz@hpe.com> Co-authored-by: Esteban Rodriguez Betancourt <estebarb@hpe.com> Co-authored-by: Jorge Arturo Sauma Vargas <jorge.sauma@hpe.com> Co-aughored-by: Lance Richardson <lrichard@redhat.com> Signed-off-by: Lance Richardson <lrichard@redhat.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
* docs: Document dpdkr portsStephen Finucane2017-06-061-0/+1
| | | | | | | | | | | | I has an idea what these were but that idea was somewhat incorrect and out-of-date. Add a minimal guide to fill in these gaps, along with a warning about how useless these things generally are now (yay, vhost-user). Signed-off-by: Stephen Finucane <stephen@that.guru> Cc: Ciara Loftus <ciara.loftus@intel.com> Cc: Kevin Traynor <ktraynor@redhat.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
* Documentation: Add an OVN tutorial for OpenStack.Ben Pfaff2017-05-041-0/+1
| | | | | Signed-off-by: Ben Pfaff <blp@ovn.org> Acked-by: Andy Zhou <azhou@ovn.org>
* doc: Remove latex output configurationStephen Finucane2017-04-211-3/+1
| | | | | | | | We don't care about building LaTeX documentation, so there's no need to keep this build cruft around. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ben Pfaff <blp@ovn.org>
* doc: Convert ovs-test to rSTStephen Finucane2017-04-211-0/+1
| | | | | Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ben Pfaff <blp@ovn.org>
* doc: Convert ovs-vlan-test to rSTStephen Finucane2017-04-211-7/+77
| | | | | | | | | | | | | | | Let's start with a simple one that lets us focus on setting up most of the required "infrastructure" for building man pages using Sphinx. This changes the 'check-htmldocs' target to 'check-docs' as its now responsible for building man page docs too. Other than that, hurrah for (mostly) legible syntaxes. [1] http://www.tldp.org/HOWTO/Man-Page/q2.html Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ben Pfaff <blp@ovn.org>
* doc: Apply flake8 to conf.py also.Ben Pfaff2017-04-141-1/+1
| | | | | | Suggested-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ben Pfaff <blp@ovn.org> Acked-by: Stephen Finucane <stephen@that.guru>
* doc: Avoid need to generate conf.py.Ben Pfaff2017-04-141-10/+0
| | | | | | | | It's awkward to have to at the same time generate conf.py from conf.py.in and to keep both versions in the repository. This avoids the issue. Signed-off-by: Ben Pfaff <blp@ovn.org> Acked-by: Stephen Finucane <stephen@that.guru>
* doc: Also delete stamp file in clean-docs target.Ben Pfaff2017-04-141-0/+1
| | | | | | | | Otherwise "make docs-check" won't necessarily do anything since its apparent target is up to date. Signed-off-by: Ben Pfaff <blp@ovn.org> Acked-by: Stephen Finucane <stephen@that.guru>
View Lorry Controller Status