Backup of today's work. Still awaiting a couple more editorial inputs.
[dwarf-doc.git] / dwarf5 / latexdoc / foreword.tex
1 \renewcommand{\abstractname}{\Large Foreword}
2 \begin{abstract}
3 \setlength{\parindent}{0pt}
4 \nonzeroparskip
5 \ \break
6 The \dwf\ Committee was originally organized in 1988 as the
7 Programming Languages Special Interest Group (PLSIG) of Unix
8 International, Inc., a trade group organized to promote Unix
9 System V Release 4 (SVR4).
10
11 PLSIG drafted a standard for \addtoindex{DWARF Version 1}, compatible with
12 the DWARF debugging format used at the time by SVR4 compilers
13 and debuggers from AT\&T.  This was published as Revision 1.1.0
14 on October 6, 1992. PLSIG also designed the \addtoindex{DWARF Version 2}
15 format, which followed the same general philosophy as Version
16 1, but with significant new functionality and a more compact,
17 though incompatible, encoding.  An industry review draft
18 of \addtoindex{DWARF Version 2} was published as Revision 2.0.0 on July
19 27, 1993.
20
21 Unix International dissolved shortly after the draft of
22 Version 2 was released; no industry comments were received or
23 addressed, and no final standard was released. The committee
24 mailing list was hosted by OpenGroup (formerly XOpen).
25
26 The Committee reorganized in October, 1999, and met for the
27 next several years to address issues that had been noted with
28 \addtoindex{DWARF Version 2} as well as to add a number of new features.
29 In mid-2003, the Committee became a workgroup under the Free
30 Standards Group (FSG), an industry consortium chartered to
31 promote open standards. \addtoindex{DWARF Version 3} was published on
32 December 20, 2005, following industry review and comment.
33
34 The DWARF Committee withdrew from the Free Standards Group
35 in February, 2007, when FSG merged with the Open Source
36 Development Labs to form The Linux Foundation, more narrowly
37 focused on promoting Linux. The DWARF Committee has been
38 independent since that time.
39
40 It is the intention of the DWARF Committee that migrating from
41 an earlier version of the DWARF standard to the current version
42 should be straightforward and easily accomplished. 
43 Almost all constructs from
44 \DWARFVersionII\addtoindexx{DWARF Version 3}\addtoindexx{DWARF Version 4}
45 onward have been retained unchanged in \DWARFVersionV, although a few
46 have been compatibly superseded by improved constructs which are
47 more compact and/or more expressive.
48
49 This document was created using the \LaTeX{} document preparation
50 system.
51
52 \clearpage
53
54 {\bfseries The \dwf{} Committee}
55
56 The \dwf{} Committee is open to compiler and debugger
57 developers who have experience with source language debugging
58 and debugging formats, and have an interest in promoting or
59 extending the DWARF debugging format.
60
61 DWARF Committee members contributing to Version 5 are:
62 \begin{center}
63 \begin{tabular}{ll}
64 Todd Allen              & Concurrent Computer\\
65 David Anderson, Associate Editor\\
66 John Bishop             & Intel\\
67 Ron Brender, Editor\\
68 Andrew Cagney\\
69 Soumitra Chatterjee     & Hewlett-Packard Enterprise\\
70 Eric Christopher        & Google\\
71 Cary Coutant            & Google\\
72 John DelSignore         & Rogue Wave\\
73 Michael Eager, Chair    & Eager Consulting\\
74 Jini Susan George       & Hewlett-Packard\\
75 Mathhew Gretton-Dan     & ARM\\
76 Tommy Hoffner           & Altera\\
77 Jakub Jel\'{i}nek       & Red Hat\\
78 Andrew Johnson          & Linaro\\
79 Jason Merrill           & Red Hat\\
80 Jason Molenda           & Apple\\
81 Adrian Prantl           & Apple\\
82 Hafiz Abid Qadeer       & Mentor Graphics\\
83 Paul Robinson           & Sony\\
84 Syamala Sarma           & Hewlett-Packard\\
85 Keith Walker            & ARM\\
86 Kendrick Wong           & IBM\\
87 Brock Wyma              & Intel\\
88 Jian Xu                 & IBM\\
89 \end{tabular}
90 \end{center}
91
92 For further information about 
93 DWARF or the DWARF Committee,
94 see:
95
96 % For unclear reasons, simply adding the url
97 % to the sentence here makes the url extend past the
98 % end of the line and generates a warning and
99 % ugly output.
100 \begin{myindentpara}{1cm}
101 \url{http://www.dwarfstd.org} 
102 \end{myindentpara}
103
104 \clearpage
105 {\bfseries How to Use This Document}
106
107 This document is intended to be usable in online as well as
108 traditional paper forms. Both online and paper forms include 
109 page numbers, a Table of Contents, a List of Figures,
110 a List of Tables and an Index.
111
112 Text in normal font describes
113 required aspects of the DWARF format.  Text in \textit{italics} is
114 explanatory or supplementary material, and not part of the
115 format definition itself.
116
117 \textit{Online Form}
118
119 In the online form, \textcolor{blue}{blue text} 
120 is used to indicate hyperlinks.
121 Most hyperlinks link to the definition of a term or
122 construct, or to a cited Section or Figure.
123 However, attributes
124 in particular are often used in more than one way or context so
125 that there is no single definition; for attributes, hyperlinks
126 link to the introductory table of all attributes which in turn
127 contains hyperlinks for the multiple usages. 
128
129 The occurrence of
130 a DWARF name in its definition (or one of its definitions in the
131 case of some attributes) is shown in \definition{red text}. 
132 Other occurrences of the same name in the same or possibly following
133 paragraphs are generally in normal text color.)
134
135 The Table of Contents, List of Figures, List of Tables and Index 
136 provide hyperlinks to the respective items and places.
137
138 \textit{Paper Form}
139
140 In the traditional paper form, the appearance of the hyperlinks
141 and definitions on a page of paper does not distract the eye 
142 because the blue hyperlinks and the color used for definitions
143 are typically imaged by black and white printers in
144 a manner nearly indistinguishable from other text. 
145 (Hyperlinks are not underlined for this same reason.) 
146
147
148 \end{abstract}