compression.tex
[dwarf-doc.git] / dwarf5 / latexdoc / introduction.tex
index 402df16..7c0d64b 100644 (file)
@@ -35,9 +35,11 @@ addtoindex{Ada},
 and \addtoindex{Fortran}; it also covers the basic needs
 of various other languages.
 
 and \addtoindex{Fortran}; it also covers the basic needs
 of various other languages.
 
-This document describes DWARF Version 4, the fourth generation
+This document describes \addtoindex{DWARF Version 4},
+the fourth generation
 of debugging information based on the DWARF format. DWARF
 of debugging information based on the DWARF format. DWARF
-Version 4 extends DWARF Version 3 in a compatible manner.
+Version 4 extends \addtoindex{DWARF Version 3}
+in a compatible manner.
 
 The intended audience for this document is the developers
 of both producers and consumers of debugging information,
 
 The intended audience for this document is the developers
 of both producers and consumers of debugging information,
@@ -75,7 +77,8 @@ Section \refersec{datarep:datarepresentation}.
 
 This organization closely follows that used in the DWARF
 Version 3 document. Except where needed to incorporate
 
 This organization closely follows that used in the DWARF
 Version 3 document. Except where needed to incorporate
-new material or to correct errors, the DWARF Version 3
+new material or to correct errors, the 
+\addtoindex{DWARF Version 3}
 text is generally reused in this document with little or
 no modification.
 
 text is generally reused in this document with little or
 no modification.
 
@@ -106,7 +109,7 @@ All
 names and values not reserved for vendor additions, however,
 are reserved for future versions of this document.
 
 names and values not reserved for vendor additions, however,
 are reserved for future versions of this document.
 
-DWARF Version 5 is intended to be permissive rather than
+\addtoindex{DWARF Version 5} is intended to be permissive rather than
 prescriptive. 
 Where this specification provides a means for
 describing the source language, implementors are expected
 prescriptive. 
 Where this specification provides a means for
 describing the source language, implementors are expected
@@ -157,10 +160,12 @@ constant expressions, Unicode character types and template aliases.
 \item Add additional support for template parameters in instantiations.
 \item Add support for strongly typed enumerations in languages (such as C++) that have two
 kinds of enumeration declarations.
 \item Add additional support for template parameters in instantiations.
 \item Add support for strongly typed enumerations in languages (such as C++) that have two
 kinds of enumeration declarations.
-DWARF Version 4 is compatible with DWARF Version 3 except as follows:
+\addtoindex{DWARF Version 4} is compatible with 
+\addtoindex{DWARF Version 3} except as follows:
 \item DWARF attributes that use any of the new forms of attribute value representation (for
 section offsets, flag compression, type signature references, and so on) cannot be read by
 \item DWARF attributes that use any of the new forms of attribute value representation (for
 section offsets, flag compression, type signature references, and so on) cannot be read by
-DWARF Version 3 consumers because the consumer will not know how to skip over the
+\addtoindex{DWARF Version 3}
+consumers because the consumer will not know how to skip over the
 unexpected form of data.
 \item DWARF frame and line table sections include a additional fields that affect the location
 and interpretation of other data in the section.
 unexpected form of data.
 \item DWARF frame and line table sections include a additional fields that affect the location
 and interpretation of other data in the section.
@@ -211,7 +216,9 @@ duplicate DWARF information during linking.
 
 \end{itemize}
 
 
 \end{itemize}
 
-DWARF Version 3 is compatible with DWARF Version 2 except as follows:
+\addtoindex{DWARF Version 3}
+is compatible with 
+\addtoindex{DWARF Version 2} except as follows:
 
 \begin{itemize}
 \item
 
 \begin{itemize}
 \item
@@ -224,8 +231,9 @@ is defined to increase the possible size of DWARF descriptions
 \item
 References that use the attribute form \livelink{chap:DWFORMrefaddr}{DW\-\_FORM\-\_ref\-\_addr}
 are specified to be four bytes in the DWARF 32-bit format and
 \item
 References that use the attribute form \livelink{chap:DWFORMrefaddr}{DW\-\_FORM\-\_ref\-\_addr}
 are specified to be four bytes in the DWARF 32-bit format and
-eight bytes in the DWARF 64-bit format, while DWARF Version
-2 specifies that such references have the same size as an
+eight bytes in the DWARF 64-bit format, while 
+\addtoindex{DWARF Version 2} 
+specifies that such references have the same size as an
 address on the target system (see Sections 7.4 and 7.5.4).
 
 \item
 address on the target system (see Sections 7.4 and 7.5.4).
 
 \item
@@ -237,9 +245,11 @@ LEB representation (see Section 6.4.1).
 
 
 \section[Changes Version1 to 2]{Changes from Version 1 to Version 2}
 
 
 \section[Changes Version1 to 2]{Changes from Version 1 to Version 2}
-DWARF Version 2 describes the second generation of debugging
-information based on the DWARF format. While DWARF Version
-2 provides new debugging information not available in
+\addtoindex{DWARF Version 2} 
+describes the second generation of debugging
+information based on the DWARF format. While 
+\addtoindex{DWARF Version 2}
+provides new debugging information not available in
 Version 1, the primary focus of the changes for Version
 2 is the representation of the information, rather than
 the information content itself. The basic structure of
 Version 1, the primary focus of the changes for Version
 2 is the representation of the information, rather than
 the information content itself. The basic structure of
@@ -264,7 +274,11 @@ file section, \addtoindex{.debug\_info}.
 
 \textit{
 A summary of the major changes
 
 \textit{
 A summary of the major changes
-made in DWARF Version 2 compared to the DWARF Version 1 may
-be found in the DWARF Version 2 document
+made in 
+\addtoindex{DWARF Version 2}
+compared to the DWARF Version 1 may
+be found in the 
+\addtoindex{DWARF Version 2}
+document
 }
 
 }