some documentation improvements

diff --git a/elftools/dwarf/dwarfinfo.py b/elftools/dwarf/dwarfinfo.py
index d805d555e49ae4d22ed59e8d31000e51eff77cfe..2201dd2d48352e26e72fe8064b6683f26971f607 100644 (file)
--- a/elftools/dwarf/dwarfinfo.py
+++ b/elftools/dwarf/dwarfinfo.py
@@ -38,11 +38,13 @@ class DWARFInfo(object):
             debug_abbrev_sec,
             debug_str_sec,
             debug_line_sec):
-        """ stream: 
-                A stream (file-like object) that contains debug sections
-            
-            elffile:
-                ELFFile reference
+        """ elffile:
+                ELFFile reference. Note that the whole DWARF processing code is
+                decoupled from the container file. This ELFFile object is just
+                used to obtain some attributes of the data, such as endianness.
+                If desired, DWARFInfo can be created without an actual ELFFile,
+                by passing a "mock" object that only provides the required
+                attributes.
 
             debug_*_sec:
                 DebugSectionDescriptor for a section

diff --git a/elftools/dwarf/lineprogram.py b/elftools/dwarf/lineprogram.py
index 5db72044a2b0911de9a05f8123520c4892ca2560..8f8485c8eaae03798d2f32d9cece52d54e238f8f 100644 (file)
--- a/elftools/dwarf/lineprogram.py
+++ b/elftools/dwarf/lineprogram.py
@@ -102,6 +102,10 @@ class LineProgram(object):
     def get_entries(self):
         """ Get the decoded entries for this line program. Return a list of
             LineProgramEntry objects.
+            Note that this contains more information than absolutely required
+            for the line table. The line table can be easily extracted from
+            the list of entries by looking only at entries with non-None
+            state.
         """
         if self._decoded_entries is None:
             self._decoded_entries = self._decode_line_program()