|
Packit |
032894 |
The elfutils documentation is very much a work in
|
|
Packit |
032894 |
progress. Contributions are welcome.
|
|
Packit |
032894 |
Please reports bugs at https://sourceware.org/bugzilla/
|
|
Packit |
032894 |
Please send additions and patches to: elfutils-devel@sourceware.org
|
|
Packit |
032894 |
|
|
Packit |
032894 |
The elfutils utilities are a new implementation of many of the
|
|
Packit |
032894 |
utilities found in binutils and consequently, the documentation for
|
|
Packit |
032894 |
most of the tools has been the the man pages for binutils. For example
|
|
Packit |
032894 |
you could refer to readelf's man page for instructions on
|
|
Packit |
032894 |
eu-readelf. This has been fine up until this point but as tools gain
|
|
Packit |
032894 |
new capabilities, they will need to have their own individual man
|
|
Packit |
032894 |
page. Forking the man pages from binutils is acceptable and the
|
|
Packit |
032894 |
current plan of action.
|
|
Packit |
032894 |
|
|
Packit |
032894 |
New utilities that do not have an analog in binutils can have their
|
|
Packit |
032894 |
initial man pages generated using a tool like help2man.
|
|
Packit |
032894 |
|
|
Packit |
032894 |
The C language interfaces for libelf, libdw, and libdwfl are in
|
|
Packit |
032894 |
particular need of documentation. The aspirational goal is write these
|
|
Packit |
032894 |
in sphinx.
|