Skip to content

Commit

Permalink
doc: Document various language bindings
Browse files Browse the repository at this point in the history
Signed-off-by: Stephen Finucane <[email protected]>
Signed-off-by: Ben Pfaff <[email protected]>
  • Loading branch information
stephenfin authored and blp committed Dec 22, 2016
1 parent ea0c5fd commit f150a8b
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 1 deletion.
1 change: 1 addition & 0 deletions Documentation/automake.mk
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ EXTRA_DIST += \
Documentation/topics/testing.rst \
Documentation/topics/high-availability.rst \
Documentation/topics/integration.rst \
Documentation/topics/language-bindings.rst \
Documentation/topics/openflow.rst \
Documentation/topics/ovsdb-replication.rst \
Documentation/topics/porting.rst \
Expand Down
4 changes: 3 additions & 1 deletion Documentation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,12 @@ Deeper Dive

- **Windows** :doc:`topics/windows`

- **Testing** :doc:`topics/testing`
- **Integrations:** :doc:`topics/language-bindings`

- **Reference Guides:** :doc:`ref/index`

- **Testing** :doc:`topics/testing`

- **Packaging:** :doc:`intro/install/debian` |
:doc:`intro/install/rhel` |
:doc:`intro/install/fedora`
Expand Down
1 change: 1 addition & 0 deletions Documentation/topics/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ that way.
ovsdb-replication
dpdk/index
windows
language-bindings
testing

.. toctree::
Expand Down
60 changes: 60 additions & 0 deletions Documentation/topics/language-bindings.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
..
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.

Convention for heading levels in Open vSwitch documentation:

======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4

Avoid deeper levels because they do not render well.

=================
Language Bindings
=================

Bindings exist for Open vSwitch in a variety of languages.

Official Bindings
-----------------

Python
~~~~~~

The Python bindings are part of the `Open vSwitch package`__. You can install
the bindings using ``pip``:

.. code-block:: shell
$ pip install ovs
__ https://github.com/openvswitch/ovs/tree/master/python/ovs

Third-Party Bindings
--------------------

Lua
~~~

- `LJIT2ovs:`__ LuaJIT binding for Open vSwitch

__ https://github.com/wiladams/LJIT2ovs

Go
~~

- `go-odp:`__ A Go library to control the Open vSwitch in-kernel datapath

__ https://github.com/weaveworks/go-odp

0 comments on commit f150a8b

Please sign in to comment.