Working checkpoint for editoial changes resulting from the
[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 \bb
45 \DWARFVersionII\addtoindexx{DWARF Version 3}\addtoindexx{DWARF Version 4}
46 \eb
47 onward have been retained unchanged in \DWARFVersionV, although a few
48 have been compatibly superseded by improved constructs which are
49 more compact and/or more expressive.
50
51 This document was created using the \LaTeX{} document preparation
52 system.
53
54 \clearpage
55
56 {\bfseries The \dwf{} Committee}
57
58 The \dwf{} Committee is open to compiler and debugger
59 developers who have experience with source language debugging
60 and debugging formats, and have an interest in promoting or
61 extending the DWARF debugging format.
62
63 DWARF Committee members contributing to Version 5 are:
64 \begin{center}
65 \begin{tabular}{ll}
66 Todd Allen              & Concurrent Computer\\
67 David Anderson, Associate Editor\\
68 John Bishop             & Intel\\
69 Ron Brender, Editor\\
70 Andrew Cagney\\
71 \bb
72 Soumitra Chatterjee     & Hewlett-Packard Enterprise\eb\\
73 Eric Christopher        & Google\\
74 Cary Coutant            & Google\\
75 John DelSignore         & Rogue Wave\\
76 Michael Eager, Chair    & Eager Consulting\\
77 \bb
78 Jini Susan George       & Hewlett-Packard\eb\\
79 Mathhew Gretton-Dan     & ARM\\
80 Tommy Hoffner           & Altera\\
81 \bb
82 Jakub Jelinek           & Red Hat\eb\\
83 Andrew Johnson          & Linaro\\
84 \bb
85 Jason Merrill           & Red Hat\eb\\
86 Jason Molenda           & Apple\\
87 Adrian Prantl           & Apple\\
88 Hafiz Abid Qadeer       & Mentor Graphics\\
89 Paul Robinson           & Sony\\
90 \bb
91 Syamala Sarma           & Hewlett-Packard\eb\\
92 Keith Walker            & ARM\\
93 Kendrick Wong           & IBM\\
94 Brock Wyma              & Intel\\
95 Jian Xu                 & IBM\\
96 \end{tabular}
97 \end{center}
98
99 For further information about 
100 DWARF or the DWARF Committee,
101 see:
102
103 % For unclear reasons, simply adding the url
104 % to the sentence here makes the url extend past the
105 % end of the line and generates a warning and
106 % ugly output.
107 \begin{myindentpara}{1cm}
108 \url{http://www.dwarfstd.org} 
109 \end{myindentpara}
110
111 \clearpage
112 {\bfseries How to Use This Document}
113
114 This document is intended to be usable in online as well as
115 traditional paper forms. Both online and paper forms include 
116 page numbers, a Table of Contents, a List of Figures,
117 a List of Tables and an Index.
118
119 \bb
120 Text in normal font describes
121 required aspects of the DWARF format.  Text in \textit{italics} is
122 explanatory or supplementary material, and not part of the
123 format definition itself.
124 \eb
125
126 \textit{Online Form}
127
128 In the online form, 
129 \bb
130 \textcolor{blue}{blue text} 
131 \eb
132 is used to indicate hyperlinks.
133 Most hyperlinks link to the definition of a term or
134 construct, or to a cited Section or Figure.
135 However, attributes
136 in particular are often used in more than one way or context so
137 that there is no single definition; for attributes, hyperlinks
138 link to the introductory table of all attributes which in turn
139 contains hyperlinks for the multiple usages. 
140
141 The occurrence of
142 a DWARF name in its definition (or one of its definitions in the
143 case of some attributes) is shown in 
144 \bb
145 \definition{this color}. 
146 \eb
147 Other occurrences of the same name in the same or possibly following
148 paragraphs are generally in normal text color.)
149
150 The Table of Contents, List of Figures, List of Tables and Index 
151 provide hyperlinks to the respective items and places.
152
153 \textit{Paper Form}
154
155 In the traditional paper form, the appearance of the hyperlinks
156 and definitions on a page of paper does not distract the eye 
157 because the blue hyperlinks and the color used for definitions
158 are typically imaged by black and white printers in
159 a manner nearly indistinguishable from other text. 
160 (Hyperlinks are not underlined for this same reason.) 
161
162
163 \end{abstract}