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 <[email protected]>
---
 python/TODO.rst    | 34 ++++++++++++++++++++++++++++++++++
 python/automake.mk |  2 ++
 2 files changed, 36 insertions(+)
 create mode 100644 python/TODO.rst

diff --git a/python/TODO.rst b/python/TODO.rst
new file mode 100644
index 000000000000..3a53489f1280
--- /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 767512f1757f..89c2ccbb06ae 100644
--- a/python/automake.mk
+++ b/python/automake.mk
@@ -117,3 +117,5 @@ $(srcdir)/python/ovs/dirs.py: python/ovs/dirs.py.template
        mv [email protected] $@
 EXTRA_DIST += python/ovs/dirs.py.template
 CLEANFILES += python/ovs/dirs.py
+
+EXTRA_DIST += python/TODO.rst
-- 
2.31.1

_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev

Reply via email to