docs: write about bugs in tcl parser

Signed-off-by: Masatake YAMATO <yamato@redhat.com>
springuper · May 20, 2017 · ab2b027 · ab2b027
1 parent a4f2b2b
commit ab2b027
Showing 1 changed file with 34 additions and 0 deletions.
diff --git a/docs/parser-tcl.rst b/docs/parser-tcl.rst
@@ -14,3 +14,37 @@ The line oriented parser captures `class`, `public|protected|private
 method`.  They are definitions in ITcl and TclOO. The new token oriented Tcl
 parser ignores them.  Instead ITcl and TclOO subparser running on Tcl base
 parser capture them.
+
+Known bugs
+----------------------------------------------------------------------
+
+Full qualified tags
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The separator used in full qualified tags should be `::` but `.` is
+used.
+
+A ITcl or TclOO class `C` can be defined in a Tcl namespace `N`:
+
+.. code-block:: Tcl
+
+    namespace eval N {
+	oo::class create C {
+	}
+    }
+
+When ``--extras=+q`` is given, currently ctags reports::
+
+	N.C ...
+
+This should be::
+
+	N::C ...
+
+Much work is needed to fix this.
+
+Nested procs
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+`proc` defined in a `proc` cannot be captured well.
+This is a regression.