Add nolink and noindex commands and use them
authorDavid Anderson <davea42@earthlink.net>
Wed, 6 Jun 2012 17:29:06 +0000 (10:29 -0700)
committerDavid Anderson <davea42@earthlink.net>
Wed, 6 Jun 2012 17:29:06 +0000 (10:29 -0700)
to finish up handling the word flag where it would be
silly to link.

dwarf5/latexdoc/datarepresentation.tex
dwarf5/latexdoc/dwarf5.tex
dwarf5/latexdoc/examples.tex

index 4e355a1..3344844 100644 (file)
@@ -571,13 +571,13 @@ expression
 or location description 
 (see Section \refersec{chap:locationdescriptions}).
 
-\item flag \\
+\item \livelink{chap:flag}{flag} \\
 A flag is represented explicitly as a single byte of data
 (\livetarg{chap:DWFORMflag}{DW\-\_FORM\-\_flag}) or 
 implicitly (\livetarg{chap:DWFORMflagpresent}{DW\-\_FORM\-\_flag\-\_present}). 
 In the
-first case, if the flag has value zero, it indicates the
-absence of the attribute; if the flag has a non\dash zero value,
+first case, if the \nolink{flag} has value zero, it indicates the
+absence of the attribute; if the \nolink{flag} has a non\dash zero value,
 it indicates the presence of the attribute. In the second
 case, the attribute is implicitly indicated as present, and
 no value is encoded in the debugging information entry itself.
index f17cf38..6d308ee 100644 (file)
@@ -77,6 +77,15 @@ escapeinside={\%*}{*)}  % if you want to add a comment within your code
 
 \newcommand{\dash}{\nobreakdash-\hspace{0pt}}  % So we handle dashes ok.
 
+% The following two let us mark a word as 'do not link' or
+% 'do not index' to indicate the word is used generically
+% and has been considered so do not index or link it.
+% There is no sigificant difference in the two commands, though
+% \nolink would be more oriented to words such as flag or address
+% that might be linked (and indexed) in some circumstances.
+\newcommand{\nolink}[1]{#1}
+\newcommand{\noindex}[1]{#1}
+
 %Fors simple index entries, this saves typing.
 \newcommand{\addtoindex}[1]{#1\index{#1}}
 
index bb50839..d05a4da 100644 (file)
@@ -288,12 +288,12 @@ Section \refersec{app:fortran90exampledwarfdescription}.
 1\$: \livelink{chap:DWTAGarraytype}{DW\-\_TAG\-\_array\-\_type}
         ! No name, default (Fortran) ordering, default stride
         \livelink{chap:DWATtype}{DW\-\_AT\-\_type}(reference to REAL)
-        \livelink{chap:DWATassociated}{DW\-\_AT\-\_associated}(expression= ! Test 'ptr\_assoc' flag
+        \livelink{chap:DWATassociated}{DW\-\_AT\-\_associated}(expression= ! Test 'ptr\_assoc' \nolink{flag}
             \livelink{chap:DWOPpushobjectaddress}{DW\-\_OP\-\_push\-\_object\-\_address}
             \livelink{chap:DWOPlit}{DW\-\_OP\-\_lit}<n> ! where n == offset(ptr\_assoc)
             \livelink{chap:DWOPplus}{DW\-\_OP\-\_plus}
             \livelink{chap:DWOPderef}{DW\-\_OP\-\_deref}
-            \livelink{chap:DWOPlit1}{DW\-\_OP\-\_lit1} ! mask for 'ptr\_assoc' flag
+            \livelink{chap:DWOPlit1}{DW\-\_OP\-\_lit1} ! mask for 'ptr\_assoc' \nolink{flag}
             \livelink{chap:DWOPand}{DW\-\_OP\-\_and})
         \livelink{chap:DWATdatalocation}{DW\-\_AT\-\_data\-\_location}(expression= ! Get raw data address
             \livelink{chap:DWOPpushobjectaddress}{DW\-\_OP\-\_push\-\_object\-\_address}
@@ -341,13 +341,13 @@ Section \refersec{app:fortran90exampledwarfdescription}.
         ! No name, default (Fortran) ordering, default stride
         \livelink{chap:DWATtype}{DW\-\_AT\-\_type}(reference to 3\$)
         \livelink{chap:DWATallocated}{DW\-\_AT\-\_allocated}(expression=
-             ! Test 'ptr\_alloc' flag
+             ! Test 'ptr\_alloc' \nolink{flag}
             \livelink{chap:DWOPpushobjectaddress}{DW\-\_OP\-\_push\-\_object\-\_address}
             \livelink{chap:DWOPlit}{DW\-\_OP\-\_lit}<n> ! where n == offset(ptr\_alloc)
             \livelink{chap:DWOPplus}{DW\-\_OP\-\_plus}
             \livelink{chap:DWOPderef}{DW\-\_OP\-\_deref}
             \livetarg{chap:DWOPlit2}{DW\-\_OP\-\_lit2}
-             ! mask for 'ptr\_alloc' flag
+             ! mask for 'ptr\_alloc' \nolink{flag}
             \livelink{chap:DWOPand}{DW\-\_OP\-\_and})
         \livelink{chap:DWATdatalocation}{DW\-\_AT\-\_data\-\_location}(expression= ! Get raw data address
             \livelink{chap:DWOPpushobjectaddress}{DW\-\_OP\-\_push\-\_object\-\_address}