Update the comments at the head of various .py files
authorDavid Anderson <davea42@earthlink.net>
Mon, 4 Jun 2012 17:07:00 +0000 (10:07 -0700)
committerDavid Anderson <davea42@earthlink.net>
Mon, 4 Jun 2012 17:07:00 +0000 (10:07 -0700)
so they better reflect what the python really does.

dwarf5/tools/attrlink.py
dwarf5/tools/fileio.py
dwarf5/tools/printstandard.py
dwarf5/tools/tohyphen.py
dwarf5/tools/uses.py

index 8619cd7..85e2b8a 100644 (file)
@@ -1,6 +1,6 @@
 # Copyright 2012 DWARF Debugging Information Format Committee
 #
-# All DW_TAG_* entries not in {} are turned into \livelink.
+# All DW_AT_* entries not in {} are turned into \livelink.
 
 import sys
 import anylink
index 9ec0b21..7609804 100644 (file)
@@ -1,6 +1,9 @@
+# Copyright 2012 DWARF Debugging Information Format Committee
 
 # All the little classes used in storing latex source data.
-# Copyright 2012 DWARF Debugging Information Format Committee
+# Reads in the tex source and builds internal lists of the
+# tokenized source.  The tokenization is adequate
+# for our purposes, but just barely adequate.
 
 import sys
 
index c7e376a..d208cf8 100644 (file)
@@ -5,6 +5,8 @@
 # Try    
 #           python printstandard.py *.tex  |sort|uniq
 
+# Useful in case certain random typos creep in to the .tex
+
 import sys
 import fileio
 
index b0d8c96..2d371d0 100644 (file)
@@ -1,7 +1,8 @@
 # Copyright 2012 DWARF Debugging Information Format Committee
 #
 # Convert DW_ and DW\_ names to DW\-\_ 
-#
+# python tohyphen.py *.tex
+# The output files have .out appended to the name.
 
 import sys
 import fileio
index 0479972..403a4d7 100644 (file)
@@ -1,13 +1,17 @@
 # Copyright 2012 DWARF Debugging Information Format Committee
 #
-# Handles the testing and update for all DW_* prefixes.
-# Called by taglink and other convenience apps to do their work.
+# Looks for odd things in the .tex source
+# and prints some information about oddities.
+# It does not create new .tex, it just 
+# prints (to standard-out) potential issues in the .tex files.
 #
-# Run as an app itself, the options are
-#    python anylink [-t prefix] ... [-all] [file] ...
-#    Use either -all or one or more -t, as in examples:
-#    python anylink -t DW_ACCESS_ -t DW_OP_   test.in test2.in
-#    python anylink -all    test.in test2.in 
+# It sort of parses the source lines, but the parsing
+# is barely adequate to the task of finding
+# oddities. Just barely.
+#
+# Run as (for example)
+#   python uses.py ../latexdoc/*.tex
+
 
 import sys
 import fileio