summaryrefslogtreecommitdiff
path: root/devtools
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2013-10-06 09:00:32 -0400
committerEric S. Raymond <esr@thyrsus.com>2013-10-06 09:00:32 -0400
commit44d98266c5bf371d9269ced4c3ec948c22d922bb (patch)
tree451db811b8dace2cddb6606164a3a37e9f631a63 /devtools
parent6731e3e3d7e3a1d20c0f2348eccff7ff4df7baf7 (diff)
downloadgpsd-44d98266c5bf371d9269ced4c3ec948c22d922bb.tar.gz
Document some conventions.
Diffstat (limited to 'devtools')
-rwxr-xr-xdevtools/tablegen.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/devtools/tablegen.py b/devtools/tablegen.py
index 61119e70..baf9bcb3 100755
--- a/devtools/tablegen.py
+++ b/devtools/tablegen.py
@@ -49,6 +49,14 @@
# of fields in the table. This may be useful for dealing with groups of
# messages that have a common head section.
#
+# This code interprets magic comments in the input
+#
+# //: Type
+# The token following "Type" is the name of the table
+# //: xxxx vocabulary
+# A subtable describing a controlled vocabulary for field xxxx in the
+# preceding table.
+#
# TO-DO: generate code for ais.py.
import sys, getopt