Browse Source

tools: Add/fix documentation

Yuri D'Elia 2 years ago
parent
commit
8455c8e585
2 changed files with 5 additions and 1 deletions
  1. 4 0
      tools/README.md
  2. 1 1
      tools/elf_mem_map

+ 4 - 0
tools/README.md

@@ -25,6 +25,10 @@ With ``--qdirstat`` and a single elf file, generate a [qdirstat](https://github.
 This assumes the running firmware generating the dump and the elf file are the same.
 This assumes the running firmware generating the dump and the elf file are the same.
 Requires Python3 and the [pyelftools](https://github.com/eliben/pyelftools) module.
 Requires Python3 and the [pyelftools](https://github.com/eliben/pyelftools) module.
 
 
+### ``dump2bin``
+
+Parse and decode a memory dump obtained from the D2/D21/D23 g-code into readable metadata and binary. The output binary is padded and extended to fit the original address range.
+
 ### ``update_eeprom``
 ### ``update_eeprom``
 
 
 Given one EEPROM dump, convert the dump to update instructions that can be sent to a printer.
 Given one EEPROM dump, convert the dump to update instructions that can be sent to a printer.

+ 1 - 1
tools/elf_mem_map

@@ -344,7 +344,7 @@ def main():
     ap = argparse.ArgumentParser(description="""
     ap = argparse.ArgumentParser(description="""
         Generate a symbol table map starting directly from an ELF
         Generate a symbol table map starting directly from an ELF
         firmware with DWARF3 debugging information.
         firmware with DWARF3 debugging information.
-        When used along with a memory dump obtained from the D2 g-code,
+        When used along with a memory dump obtained from the D2/D21/D23 g-code,
         show the value of each symbol which is within the address range.
         show the value of each symbol which is within the address range.
     """)
     """)
     ap.add_argument('elf', help='ELF file containing DWARF debugging information')
     ap.add_argument('elf', help='ELF file containing DWARF debugging information')