1da0c48c4Sopenharmony_ciThe elfutils documentation is very much a work in
2da0c48c4Sopenharmony_ciprogress. Contributions are welcome.
3da0c48c4Sopenharmony_ciPlease reports bugs at https://sourceware.org/bugzilla/
4da0c48c4Sopenharmony_ciPlease send additions and patches to: elfutils-devel@sourceware.org
5da0c48c4Sopenharmony_ci
6da0c48c4Sopenharmony_ciThe elfutils utilities are a new implementation of many of the
7da0c48c4Sopenharmony_ciutilities found in binutils and consequently, the documentation for
8da0c48c4Sopenharmony_cimost of the tools has been the the man pages for binutils. For example
9da0c48c4Sopenharmony_ciyou could refer to readelf's man page for instructions on
10da0c48c4Sopenharmony_cieu-readelf. This has been fine up until this point but as tools gain
11da0c48c4Sopenharmony_cinew capabilities, they will need to have their own individual man
12da0c48c4Sopenharmony_cipage. Forking the man pages from binutils is acceptable and the
13da0c48c4Sopenharmony_cicurrent plan of action.
14da0c48c4Sopenharmony_ci
15da0c48c4Sopenharmony_ciNew utilities that do not have an analog in binutils can have their
16da0c48c4Sopenharmony_ciinitial man pages generated using a tool like help2man.
17da0c48c4Sopenharmony_ci
18da0c48c4Sopenharmony_ciThe C language interfaces for libelf, libdw, and libdwfl are in
19da0c48c4Sopenharmony_ciparticular need of documentation. The aspirational goal is write these
20da0c48c4Sopenharmony_ciin sphinx.