Incorporate changes as of the May 17 meeting. The corresponding
[dwarf-doc.git] / dwarf5 / latexdoc / foreword.tex
index 6cfd6ae..3cf6959 100644 (file)
@@ -41,16 +41,19 @@ It is the intention of the DWARF Committee that migrating from
 an earlier version of the DWARF standard to the current version
 should be straightforward and easily accomplished. 
 Almost all constructs from
-\addtoindex{DWARF Version 2} onward 
-\addtoindexx{DWARF Version 3}
-\addtoindexx{DWARF Version 4}
-have been retained unchanged in DWARF Version 5, although a few
-\addtoindexx{DWARF Version 5}
+\DWARFVersionII\addtoindexx{DWARF Version 3}\addtoindexx{DWARF Version 4}
+onward have been retained unchanged in \DWARFVersionV, although a few
 have been compatibly superseded by improved constructs which are
 more compact and/or more expressive.
+
+This document was created using the \LaTeX{} document preparation
+system.
+
 \clearpage
 
-The \dwf\ Committee is open to compiler and debugger
+{\bfseries The \dwf{} Committee}
+
+The \dwf{} Committee is open to compiler and debugger
 developers who have experience with source language debugging
 and debugging formats, and have an interest in promoting or
 extending the DWARF debugging format.
@@ -63,22 +66,22 @@ David Anderson, Associate Editor\\
 John Bishop             & Intel\\
 Ron Brender, Editor\\
 Andrew Cagney\\
-Soumitra Chatterjee     & H\\
+Soumitra Chatterjee     & Hewlett-Packard Enterprise\\
 Eric Christopher        & Google\\
 Cary Coutant            & Google\\
 John DelSignore         & Rogue Wave\\
 Michael Eager, Chair    & Eager Consulting\\
-Jini Susan George       & H\\
+Jini Susan George       & Hewlett-Packard\\
 Mathhew Gretton-Dan     & ARM\\
 Tommy Hoffner           & Altera\\
-Jakub Jelinek           & RedHat\\
+Jakub Jelinek           & Red Hat\\
 Andrew Johnson          & Linaro\\
-Jason Merrill           & RedHat\\
+Jason Merrill           & Red Hat\\
 Jason Molenda           & Apple\\
 Adrian Prantl           & Apple\\
 Hafiz Abid Qadeer       & Mentor Graphics\\
 Paul Robinson           & Sony\\
-Syamala Sarma           & HP\\
+Syamala Sarma           & Hewlett-Packard\\
 Keith Walker            & ARM\\
 Kendrick Wong           & IBM\\
 Brock Wyma              & Intel\\
@@ -98,30 +101,48 @@ see:
 \url{http://www.dwarfstd.org} 
 \end{myindentpara}
 
+\clearpage
+{\bfseries How to Use This Document}
+
 This document is intended to be usable in online as well as
-traditional paper forms. 
+traditional paper forms. Both online and paper forms include 
+page numbers, a Table of Contents, a List of Figures,
+a List of Tables and an Index.
 
-In the online form, blue text is used to indicate hyperlinks.
-% which facilitate moving around
-%in the document in a manner like that typically found in web
-%browsers.
+Text in normal font describes
+required aspects of the DWARF format.  Text in \textit{italics} is
+explanatory or supplementary material, and not part of the
+format definition itself.
+
+\textit{Online Form}
+
+In the online form, \textcolor{blue}{blue text} 
+is used to indicate hyperlinks.
 Most hyperlinks link to the definition of a term or
 construct, or to a cited Section or Figure.
 However, attributes
 in particular are often used in more than one way or context so
 that there is no single definition; for attributes, hyperlinks
-link to the introductory list of all attributes which in turn
-contains hyperlinks for the multiple usages.
-The Table of
-Contents also provides hyperlinks to the respective sections.
+link to the introductory table of all attributes which in turn
+contains hyperlinks for the multiple usages. 
+
+The occurrence of
+a DWARF name in its definition (or one of its definitions in the
+case of some attributes) is shown in \definition{red text}. 
+Other occurrences of the same name in the same or possibly following
+paragraphs are generally in normal text color.)
+
+The Table of Contents, List of Figures, List of Tables and Index 
+provide hyperlinks to the respective items and places.
+
+\textit{Paper Form}
 
 In the traditional paper form, the appearance of the hyperlinks
-on a page of paper does not distract the eye because the blue
-hyperlinks are typically imaged by black and white printers in
+and definitions on a page of paper does not distract the eye 
+because the blue hyperlinks and the color used for definitions
+are typically imaged by black and white printers in
 a manner nearly indistinguishable from other text. 
 (Hyperlinks are not underlined for this same reason.) 
 
-Both online and paper forms include 
-page numbers, a Table of Contents, a List of Figures and an Index.
 
 \end{abstract}