tools: Add/fix documentation

This commit is contained in:
Yuri D'Elia 2021-06-22 17:56:42 +02:00 committed by DRracer
parent 43b9a2d3df
commit 8455c8e585
2 changed files with 5 additions and 1 deletions

View File

@ -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.
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``
Given one EEPROM dump, convert the dump to update instructions that can be sent to a printer.

View File

@ -344,7 +344,7 @@ def main():
ap = argparse.ArgumentParser(description="""
Generate a symbol table map starting directly from an ELF
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.
""")
ap.add_argument('elf', help='ELF file containing DWARF debugging information')