summaryrefslogtreecommitdiff
path: root/python
diff options
context:
space:
mode:
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