-pyelftools\r
-----------\r
+Introduction: what is pyelftools?\r
+---------------------------------\r
+\r
+**pyelftools** is a pure-Python library for parsing and analyzing ELF files\r
+and DWARF debugging information.\r
+\r
+Pre-requisites\r
+--------------\r
+\r
+**pyelftools** needs only Python to run. It works with Python versions 2.6 and\r
+2.7 (Python 3 support is planned but not yet implemented). For hacking on \r
+**pyelftools** the requirements are a bit more strict, please see the\r
+user's guide (ZZZ: link?)\r
+\r
+\r
\r
-Nice project, heh?\r
\r
\r
self.abbrev_code)
self.tag = abbrev_decl['tag']
self.has_children = abbrev_decl.has_children()
-
- # The offset of the .debug_info section in the stream. Used to compute
- # relative offset of attribute values to the beginning of the section.
- section_offset = self.dwarfinfo.debug_info_sec.global_offset
# Guided by the attributes listed in the abbreviation declaration, parse
# values from the stream.
# global_offset: the global offset of the section in its container file
# size: the size of the section's data, in bytes
#
+# 'name' and 'global_offset' are for descriptional purposes only and
+# aren't strictly required for the DWARF parsing to work.
+#
DebugSectionDescriptor = namedtuple('DebugSectionDescriptor',
'stream name global_offset size')