Document elf2tag script

[ndim]

This aims to add documentation to the elf2tag script (installed to $(bindir) by default):

• Add -h and --help argument handling to print the usage information.

• Add a very basic man page elf2tag.1.

  Some distributions encourage having man pages (e.g. Fedora), some other distributions require a man page for each executable in $(bindir) (e.g. Debian).

  It makes sense to concentrate this documentation effort at the place common to all distributions, i.e. upstream, i.e. here.

TODO:

• Build elf2tag.1 from elf2tag.1.adoc using the update-elf2tag-manpage script as git precommit hook, CI command, or buildsystem command, or just commit elf2tag.1 without elf2tag.1.adoc and update-elf2tag-manpage (like the avrdude.1 file)?

• Is the example command with avrdude disasm accurate?

[stefanrueger]

Cool idea!

[ndim]

Does this need any additions?

ELF2TAG(1)                     avrdude Manual                     ELF2TAG(1)

NAME
       elf2tag - output a tagfile for the avrdude disasm command

SYNOPSIS
       elf2tag <file.elf>

       elf2tag [-h | --help]

DESCRIPTION
       elf2tag generates a tagfile for use with the avrdude disasm command.

OPTIONS
       -h --help
           Prints the help message and exits.

EXAMPLES
           $ elf2tag file.elf > file.tag
           $ avrdude -t ...
           avrdude> ...
           avrdude> disasm -t=file.tag ...

AUTHORS
       elf2tag was written by Johannes Bauer with small modifications by
       Stefan Rueger.

SEE ALSO
       avrdude(1), avr-nm(1), avr-objdump(1)

avrdude                          2024-09-04                       ELF2TAG(1)

[stefanrueger]

Is the example command with avrdude disasm accurate?

@ndim Here a more extensive example using blink.elf compiled for ATmega328P as input:

$ elf2tag blink.elf  >blink.tag
$ avrdude -qq -c dryrun -p m328p -U blink.elf -t
avrdude> disasm -t=blink.tag flash 0 512