diff mbox

[ovs-dev,5/6] doc: Document various language bindings

Message ID 20161217222342.21653-5-stephen@that.guru
State Accepted
Headers show

Commit Message

Stephen Finucane Dec. 17, 2016, 10:23 p.m. UTC 
Signed-off-by: Stephen Finucane <stephen@that.guru>
---
 Documentation/automake.mk                  |  1 +
 Documentation/index.rst                    |  2 +
 Documentation/topics/index.rst             |  1 +
 Documentation/topics/language-bindings.rst | 60 ++++++++++++++++++++++++++++++
 4 files changed, 64 insertions(+)
 create mode 100644 Documentation/topics/language-bindings.rst
diff mbox

Patch

diff --git a/Documentation/automake.mk b/Documentation/automake.mk
index 996bbf6..5d675d7 100644
--- a/Documentation/automake.mk
+++ b/Documentation/automake.mk
@@ -29,6 +29,7 @@  EXTRA_DIST += \
 	Documentation/topics/dpdk.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 \
diff --git a/Documentation/index.rst b/Documentation/index.rst
index fa9dca5..7926919 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -61,6 +61,8 @@  vSwitch? Start here.
 Deeper Dive
 -----------
 
+- **Integrations:** :doc:`topics/language-bindings`
+
 - **Reference Guides:** :doc:`ref/index`
 
 - **Packaging:** :doc:`intro/install/debian` |
diff --git a/Documentation/topics/index.rst b/Documentation/topics/index.rst
index 30f74fe..79b1c82 100644
--- a/Documentation/topics/index.rst
+++ b/Documentation/topics/index.rst
@@ -42,6 +42,7 @@  that way.
    ovsdb-replication
    dpdk
    windows
+   language-bindings
 
 .. toctree::
    :maxdepth: 2
diff --git a/Documentation/topics/language-bindings.rst b/Documentation/topics/language-bindings.rst
new file mode 100644
index 0000000..5114125
--- /dev/null
+++ b/Documentation/topics/language-bindings.rst
@@ -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