forked from openvswitch/ovs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: Document various language bindings
Signed-off-by: Stephen Finucane <[email protected]> Signed-off-by: Ben Pfaff <[email protected]>
- Loading branch information
1 parent
ea0c5fd
commit f150a8b
Showing
4 changed files
with
65 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -42,6 +42,7 @@ that way. | |
ovsdb-replication | ||
dpdk/index | ||
windows | ||
language-bindings | ||
testing | ||
|
||
.. toctree:: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |