Incorporate changes through March 2014, except for
[dwarf-doc.git] / dwarf5 / latexdoc / sectionversionnumbers.tex
1
2 \chapter[Section Version Numbers (Informative)]{DWARF Section Version Numbers (Informative)}
3 \label{app:dwarfsectionversionnumbersinformative}
4 \addtoindexx{version number!by section}
5
6 % The table format looks rather different that V4 and earlier
7 % as latex took up too much space and left no room for V5
8 % or later.  The new format uses space more efficiently.
9
10 Most DWARF sections have a version number in the section
11 header. This version number is not tied to the DWARF standard
12 revision numbers, but instead is incremented when incompatible
13 changes to that section are made. The DWARF standard that
14 a producer is following is not explicitly encoded in the
15 file. Version numbers in the section headers are represented
16 as two byte unsigned integers. 
17
18 Table \refersec{tab:sectionversionnumbers}
19 shows what version
20 numbers are in use for each section.
21
22 There are sections with no version number encoded in them;
23 they are only accessed via the 
24 \dotdebuginfo{} 
25 sections and so an incompatible change in those sections'
26 format would be represented by a change in the 
27 \dotdebuginfo{} section version number.
28
29 \begin{centering}
30 \setlength{\extrarowheight}{0.1cm}
31 \begin{longtable}{lcccc}
32   \caption{Section version numbers} \label{tab:sectionversionnumbers} \\
33   \hline \bfseries Section Name &\bfseries V2 &\bfseries V3 &\bfseries V4 &\bfseries V5 \\ \hline
34 \endfirsthead
35    \bfseries Section Name &\bfseries V2 &\bfseries V3 &\bfseries V4 &\bfseries V5 \\ \hline
36 \endhead
37   \hline \emph{Continued on next page}
38 \endfoot
39   \hline
40 \endlastfoot
41 \dotdebugabbrev{}   & - & - & - & - \\
42 \dotdebugaddr{}         & x & x & x & 5 \\
43 \dotdebugaranges{}  & 2 & 2 & 2 & 2 \\
44 \dotdebugframe{}    & 1 & 3 & 4 & 4 \\
45 \dotdebuginfo{}     & 2 & 3 & 4 & 5 \\
46 \dotdebugline{}     & 2 & 3 & 4 & 5 \\
47 \dotdebugloc{}      & - & - & - & 5 \\
48 \dotdebugmacinfo{}  & - & - & - & x \\
49 \dotdebugmacro{}    & x & x & x & 5 \\
50 \dotdebugpubnames{} & 2 & 2 & 2 & 2 \\
51 \dotdebugpubtypes{} & x & 2 & 2 & 2 \\
52 \dotdebugranges{}   & x & - & - & 5 \\
53 \dotdebugstr{}      & - & - & - & - \\
54 \dotdebugstroffsets & x & x & x & 5 \\
55
56 \hspace{3cm}\textit{(.dwo sections)}                              \\
57 \dotdebugabbrevdwo  & x & x & x & 5 \\
58 \dotdebuginfodwo    & x & x & x & 5 \\
59 \dotdebuglinedwo    & x & x & x & 5 \\
60 \dotdebuglocdwo     & x & x & x & 5 \\
61 \dotdebugmacrodwo   & x & x & x & 5 \\
62 \dotdebugstrdwo     & x & x & x & - \\
63 \dotdebugstroffsetsdwo 
64                     & x & x & x & 5 \\
65
66 \end{longtable}
67 \end{centering}
68
69 Notes:
70
71 \begin{itemize}
72 \item  \doublequote{V2} means \addtoindex{DWARF Version 2}, published July 27, 1993.
73 \item  \doublequote{V3} means \addtoindex{DWARF Version 3}, published December 20, 2005.
74 \item  \doublequote{V4} means \addtoindex{DWARF Version 4}, published June 10, 2010.
75 \item  \doublequote{V5} means \addtoindex{DWARF Version 5}, published 
76                         \ifthenelse{\boolean{isdraft}}{\textit{<to be determined>}}{\docdate}.
77 \item  \doublequote{-} means that a version number is not applicable
78 (the section does not include a header or the section's header does not include a version).
79
80 \item  \doublequote{x} means that the section was not defined in that
81 version of the DWARF standard.
82
83 \item  The version numbers for corresponding .debug\_<kind> and .debug\_<kind>.dwo 
84 sections are the same.
85
86 \end{itemize}
87
88 \textit{For the \dotdebugframe{} section, version 2 is unused.}
89
90 Higher numbers are reserved for future use.
91