Complete figure to table conversion; other cleanups
[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 \addtoindex{.debug\_info} and 
25 \addtoindex{.debug\_types}
26 sections and so an incompatible change in those sections'
27 format would be represented by a change in the 
28 and \addtoindex{.debug\_types} section version number.
29
30 \clearpage
31 \begin{centering}
32 \setlength{\extrarowheight}{0.1cm}
33 \begin{longtable}{lccc}
34   \caption{Section version numbers} \label{tab:sectionversionnumbers} \\
35   \hline \bfseries Section Name &\bfseries V2 &\bfseries V3 &\bfseries V4 \\ \hline
36 \endfirsthead
37    \bfseries Section Name &\bfseries V2 &\bfseries V3 &\bfseries V4 \\ \hline
38 \endhead
39   \hline \emph{Continued on next page}
40 \endfoot
41   \hline
42 \endlastfoot
43 \addtoindex{.debug\_abbrev}& -  & -  & -  \\
44 \addtoindex{.debug\_aranges}&2&2&2 \\
45 \addtoindex{.debug\_frame}&1&3&4 \\
46 \addtoindex{.debug\_info}&2&3&4 \\
47 \addtoindex{.debug\_line}&2&3&4   \\
48 \addtoindex{.debug\_loc}& -  & -  & -  \\
49 \addtoindex{.debug\_macinfo}& -  & - & -   \\
50 \addtoindex{.debug\_pubnames}&2&2&2    \\
51 \addtoindex{.debug\_pubtypes}&x&2&2   \\
52 \addtoindex{.debug\_ranges}&x& - & -  \\
53 \addtoindex{.debug\_str}& -  & -  & -  \\
54 \addtoindex{.debug\_types}&x&x&4   \\
55 \end{longtable}
56 \end{centering}
57
58 Notes:
59
60 \begin{itemize}
61 \item  ``V2'' means \addtoindex{DWARF Version 2}, published July 1993.
62 \item  ``V3'' means \addtoindex{DWARF Version 3}, published December 2005.
63 \item  ``V4'' means \addtoindex{DWARF Version 4}, published June 2010.
64 \item  ``-'' means that a version number is not applicable
65 (the section's header does not include a version).
66
67 \item  ``x'' means that the section was not defined in that
68 version of the DWARF standard.
69
70 \item  The version numbers for the \addtoindex{.debug\_info} and \addtoindex{.debug\_types}
71 sections must be the same.
72
73 \end{itemize}
74
75 \textit{For \addtoindex{.debug\_frame}, section version 2 is unused.}
76
77 Higher numbers are reserved for future use.
78