Backup of today's work. Still awaiting a couple more editorial inputs.
[dwarf-doc.git] / dwarf5 / latexdoc / foreword.tex
index 097855d..f5d579f 100644 (file)
@@ -1,21 +1,21 @@
-\renewcommand{\abstractname}{Foreword}
-\setlength{\parindent}{0pt}
+\renewcommand{\abstractname}{\Large Foreword}
 \begin{abstract}
-\nonzeroparskip
 \setlength{\parindent}{0pt}
+\nonzeroparskip
+\ \break
 The \dwf\ Committee was originally organized in 1988 as the
 Programming Languages Special Interest Group (PLSIG) of Unix
 International, Inc., a trade group organized to promote Unix
 System V Release 4 (SVR4).
 
-PLSIG drafted a standard for DWARF Version 1, compatible with
+PLSIG drafted a standard for \addtoindex{DWARF Version 1}, compatible with
 the DWARF debugging format used at the time by SVR4 compilers
 and debuggers from AT\&T.  This was published as Revision 1.1.0
-on October 6, 1992. PLSIG also designed the DWARF Version 2
+on October 6, 1992. PLSIG also designed the \addtoindex{DWARF Version 2}
 format, which followed the same general philosophy as Version
 1, but with significant new functionality and a more compact,
 though incompatible, encoding.  An industry review draft
-of DWARF Version 2 was published as Revision 2.0.0 on July
+of \addtoindex{DWARF Version 2} was published as Revision 2.0.0 on July
 27, 1993.
 
 Unix International dissolved shortly after the draft of
@@ -25,10 +25,10 @@ mailing list was hosted by OpenGroup (formerly XOpen).
 
 The Committee reorganized in October, 1999, and met for the
 next several years to address issues that had been noted with
-DWARF Version 2 as well as to add a number of new features.
+\addtoindex{DWARF Version 2} as well as to add a number of new features.
 In mid-2003, the Committee became a workgroup under the Free
-Standards Group (FSG), a industry consortium chartered to
-promote open standards. DWARF Version 3 was published on
+Standards Group (FSG), an industry consortium chartered to
+promote open standards. \addtoindex{DWARF Version 3} was published on
 December 20, 2005, following industry review and comment.
 
 The DWARF Committee withdrew from the Free Standards Group
@@ -37,41 +37,55 @@ Development Labs to form The Linux Foundation, more narrowly
 focused on promoting Linux. The DWARF Committee has been
 independent since that time.
 
-It is the intention of the DWARF Committee that migrating
-from DWARF Version 2 or Version 3 
-or Version 4 to later versions should
-be straightforward and easily accomplished. 
-Almost all DWARF
-Version 2 and Version 3 and Version 4 
-constructs have been retained unchanged
-in DWARF Version 5.
+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
+\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.
 
-The \dwf\ Committee is open to compiler and debugger
+This document was created using the \LaTeX{} document preparation
+system.
+
+\clearpage
+
+{\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.
-\clearpage
+
 DWARF Committee members contributing to Version 5 are:
 \begin{center}
 \begin{tabular}{ll}
-Todd Allen&Concurrent Computer\\
-David Anderson\\
-John Bishop&Intel\\
-Jim Blandy&CodeSourcery\\
+Todd Allen              & Concurrent Computer\\
+David Anderson, Associate Editor\\
+John Bishop             & Intel\\
 Ron Brender, Editor\\
 Andrew Cagney\\
-Eric Christopher&Apple\\
-Cary Coutant&Google\\
-John DelSignore&TotalView\\
-Michael Eager, Chair&Eager Consulting\\
-Jini Susan George&HP\\
-Matthew Gretton-Dann&ARM\\
-Tommy Hoffner&IBM\\
-Jakub Jelinek&RedHat\\
-Jason Molenda&Apple\\
-Syamala Sarma&HP\\
-Kendrick Wong&IBM\\
-Brock Wyma&Intel
+Soumitra Chatterjee     & Hewlett-Packard Enterprise\\
+Eric Christopher        & Google\\
+Cary Coutant            & Google\\
+John DelSignore         & Rogue Wave\\
+Michael Eager, Chair    & Eager Consulting\\
+Jini Susan George       & Hewlett-Packard\\
+Mathhew Gretton-Dan     & ARM\\
+Tommy Hoffner           & Altera\\
+Jakub Jel\'{i}nek       & Red Hat\\
+Andrew Johnson          & Linaro\\
+Jason Merrill           & Red Hat\\
+Jason Molenda           & Apple\\
+Adrian Prantl           & Apple\\
+Hafiz Abid Qadeer       & Mentor Graphics\\
+Paul Robinson           & Sony\\
+Syamala Sarma           & Hewlett-Packard\\
+Keith Walker            & ARM\\
+Kendrick Wong           & IBM\\
+Brock Wyma              & Intel\\
+Jian Xu                 & IBM\\
 \end{tabular}
 \end{center}
 
@@ -87,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. 
-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.
+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.
+
+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.) 
-Page numbers,
-a Table of Contents, a List of Figures and an Index are
-included in both online and paper forms.
+(Hyperlinks are not underlined for this same reason.) 
+
 
 \end{abstract}