Corrects verbatim to be alltt in one crucial spot
[dwarf-doc.git] / dwarf5 / latexdoc / typeentries.tex
index 992e10b..d61a378 100644 (file)
@@ -94,7 +94,8 @@ is
 \addtoindexx{bit offset attribute}
 new 
 \addtoindexx{data bit offset attribute}
-in DWARF Version 4 and
+in 
+\addtoindex{DWARF Version 4} and
 is also used for bit field members 
 (see Section \refersec{chap:datamemberentries}). 
 It
@@ -109,11 +110,14 @@ big\dash endian architectures but which is wasteful for use on
 little\dash endian architectures.}
 
 \textit{The attribute \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset} is 
-deprecated in DWARF Version
-4 for use in base types, but implementations may continue to
+deprecated in 
+\addtoindex{DWARF Version 4}
+for use in base types, but implementations may continue to
 support its use for compatibility.}
 
-\textit{The DWARF Version 3 definition of these attributes is as follows.}
+\textit{The 
+\addtoindex{DWARF Version 3}
+definition of these attributes is as follows.}
 
 \begin{myindentpara}{1cm}
 \textit{A base type entry has a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}
@@ -137,7 +141,12 @@ high order bit of a value of the given type from the high
 order bit of the storage unit used to contain that value.}
 \end{myindentpara}
 
-\textit{In comparing DWARF Versions 3 and 4, note that DWARF V4
+\textit{In comparing 
+DWARF Versions 3 
+\addtoindexx{DWARF Version 3}
+and 
+\addtoindexx{DWARF Version 4} and 
+4, note that DWARF V4
 defines the following combinations of attributes:}
 
 \begin{itemize}
@@ -147,7 +156,9 @@ defines the following combinations of attributes:}
 \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} 
 and optionally \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset}}
 \end{itemize}
-DWARF V3 defines the following combinations:
+DWARF V3 
+\addtoindexx{DWARF Version 3}
+defines the following combinations:
 % FIXME: the figure below interferes with the following
 % bullet list, which looks horrible as a result.
 \begin{itemize}
@@ -475,14 +486,12 @@ rvalue reference to an object of the type being modified
 \label{fig:typemodifiertags}
 \end{figure}
 
-% The following prevents splitting the examples up.
-% FIXME perhaps there is a better way. We could box the verbatim, 
-% see memman.pdf on verbatims.
+%The following clearpage prevents splitting the example across pages.
 \clearpage
-\textit{As examples of how tye modifiers are ordered, take the following C
+\textit{As examples of how type modifiers are ordered, take the following C
 declarations:}
 
-\begin{verbatim}
+\begin{alltt}
 const unsigned char * volatile p;
     which represents a volatile pointer to a constant
     character. This is encoded in DWARF as:
@@ -502,7 +511,7 @@ volatile unsigned char * const restrict p;
                         \livelink{chap:DWTAGvolatiletype}{DW\-\_TAG\-\_volatile\-\_type} -->
                             \livelink{chap:DWTAGbasetype}{DW\-\_TAG\-\_base\-\_type}(unsigned char)
 
-\end{verbatim}
+\end{alltt}
 
 \section{Typedef Entries}
 \label{chap:typedefentries}
@@ -700,6 +709,7 @@ to hold an instance of the structure, union or class type,
 including any padding.  An incomplete structure, union or
 class type is represented by a structure, union or class
 entry that does not have a byte size attribute and that has
+\addtoindexx{declaration attribute}
 a \livelink{chap:DWATdeclaration}{DW\-\_AT\-\_declaration} attribute.
 
 If the complete declaration of a type has been placed in
@@ -791,7 +801,10 @@ declarations in the source program.
 \subsection{Derived or Extended Structs, Classes and Interfaces}
 \label{chap:derivedorextendedstructsclasesandinterfaces}
 
-\textit{In \addtoindex{C++}, a class (or struct) may be ``derived from'' or be a
+\textit{In \addtoindex{C++}, a class (or struct) 
+may 
+\addtoindexx{derived type (C++)|see{inheritance entry}}
+be ``derived from'' or be a
 ``subclass of'' another class. In Java, an interface may ``extend''
 one or more other interfaces, and a class may ``extend'' another
 class and/or ``implement'' one or more interfaces. All of these
@@ -1122,7 +1135,9 @@ and arrays, see
 Appendix \refersec{app:pascalexample}.}
 
 \textit{Attribute \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset} 
-is new in DWARF Version 4 and is also used for base types 
+is new in 
+\addtoindex{DWARF Version 4}
+and is also used for base types 
 (see Section 
 \refersec{chap:basetypeentries}). 
 It replaces the
@@ -1144,7 +1159,9 @@ attribute combination is deprecated for data members in DWARF
 Version 4, but implementations may continue to support this
 use for compatibility.}
 
-\textit{The DWARF Version 3 definitions of these attributes are
+\textit{The 
+\addtoindex{DWARF Version 3} 
+definitions of these attributes are
 as follows.}
 
 \begin{myindentpara}{1cm}
@@ -1194,9 +1211,15 @@ the bit field is the value of the bit offset attribute.}
 \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}, 
 \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} and 
 \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset} attribute
-combination may be found in the DWARF Version 3 Standard.}
+combination may be found in the 
+\addtoindex{DWARF Version 3} Standard.}
 
-\textit{In comparing DWARF Versions 3 and 4, note that DWARF V4
+\textit{In comparing 
+DWARF Versions 3 
+\addtoindexx{DWARF Version 3}
+and 
+\addtoindexx{DWARF Version 4}
+4, note that DWARF V4
 defines the following combinations of attributes:}
 
 \begin{itemize}
@@ -1395,11 +1418,15 @@ owned by the corresponding structure type entry.
 
 If the variant part has a discriminant, the discriminant is
 \hypertarget{chap:DWATdiscrdiscriminantofvariantpart}
-represented by a separate debugging information entry which
+represented by a 
+\addtoindexx{discriminant (entry)}
+separate debugging information entry which
 is a child of the variant part entry. This entry has the form
 of a structure data member entry. The variant part entry will
+\addtoindexx{discriminant attribute}
 have a 
-\livelink{chap:DWATdiscr}{DW\-\_AT\-\_discr} attribute whose value is a reference to
+\livelink{chap:DWATdiscr}{DW\-\_AT\-\_discr} attribute 
+whose value is a reference to
 the member entry for the discriminant.
 
 If the variant part does not have a discriminant (tag field),
@@ -1423,7 +1450,9 @@ an unsigned type.
 
 Alternatively, 
 \hypertarget{chap:DWATdiscrlistlistofdiscriminantvalues}
-the variant entry may contain a 
+the variant entry may contain 
+\addtoindexx{discriminant list attribute}
+a 
 \livelink{chap:DWATdiscrlist}{DW\-\_AT\-\_discr\-\_list}
 attribute, whose value represents a list of discriminant
 values. This list is represented by any of the 
@@ -1432,7 +1461,9 @@ may contain a mixture of case labels and label ranges. Each
 item on the list is prefixed with a discriminant value
 descriptor that determines whether the list item represents
 a single label or a label range. A single case label is
-represented as an LEB128 number as defined above for the
+represented as an LEB128 number as defined above for 
+\addtoindexx{discriminant value attribute}
+the
 \livelink{chap:DWATdiscrvalue}{DW\-\_AT\-\_discr\-\_value} 
 attribute. A label range is represented by
 two LEB128 numbers, the low value of the range followed by the