summaryrefslogtreecommitdiff
path: root/python
diff options
context:
space:
mode:
authorDumitru Ceara <dceara@redhat.com>2022-06-27 12:44:32 +0200
committerIlya Maximets <i.maximets@ovn.org>2022-06-28 13:47:34 +0200
commit6835d4b01e7523535876cd8b6a3e84b23c7d58d1 (patch)
treeb94a9b855248e4c2773ebaa3bd582b366455286a /python
parenta9ec4e3be3be8d0a6e2e0b4571d94b045cf671c6 (diff)
downloadopenvswitch-6835d4b01e7523535876cd8b6a3e84b23c7d58d1.tar.gz
python: Add Python bindings TODO file.
For now include the IDL related TODO items as discussed at: https://mail.openvswitch.org/pipermail/ovs-dev/2022-April/393516.html Signed-off-by: Dumitru Ceara <dceara@redhat.com> Acked-by: Terry Wilson <twilson@redhat.com> Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
Diffstat (limited to 'python')
-rw-r--r--python/TODO.rst34
-rw-r--r--python/automake.mk2
2 files changed, 36 insertions, 0 deletions
diff --git a/python/TODO.rst b/python/TODO.rst
new file mode 100644
index 000000000..3a53489f1
--- /dev/null
+++ b/python/TODO.rst
@@ -0,0 +1,34 @@
+..
+ 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.
+
+==========================
+Python Bindings To-do List
+==========================
+
+* IDL:
+
+ * Support incremental change tracking monitor mode (equivalent of
+ OVSDB_IDL_TRACK).
+
+ * Support write-only-changed monitor mode (equivalent of
+ OVSDB_IDL_WRITE_CHANGED_ONLY).
diff --git a/python/automake.mk b/python/automake.mk
index 767512f17..89c2ccbb0 100644
--- a/python/automake.mk
+++ b/python/automake.mk
@@ -117,3 +117,5 @@ $(srcdir)/python/ovs/dirs.py: python/ovs/dirs.py.template
mv $@.tmp $@
EXTRA_DIST += python/ovs/dirs.py.template
CLEANFILES += python/ovs/dirs.py
+
+EXTRA_DIST += python/TODO.rst