Blame doc/README

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