mirror of
https://github.com/openharmony/third_party_elfutils.git
synced 2026-07-01 06:41:51 -04:00
Ben Woodard
f0a5176739
- Added doc/README - Updated doc/ChangeLog - Added a eu-readelf manpage based on the one from binutils. - Added a brand new manpage for eu-elfclassify the new utility. - Add some new files in the doc directory and sync makefile with upstream. - Reenable the compilation of doc directory. - Disable sgml file building - Build man pages the automake way Since V1 - Put man pages in the proper directories. - Added copy of Gnu Free Documentation License - Modified eu-readelf.1 man page to match the supported options. Signed-off-by: Ben Woodard <woodard@redhat.com> Signed-off-by: Mark Wielaard <mark@klomp.org>
20 lines
966 B
Plaintext
20 lines
966 B
Plaintext
The elfutils documentation is very much a work in
|
|
progress. Contributions are welcome.
|
|
Please reports bugs at https://sourceware.org/bugzilla/
|
|
Please send additions and patches to: elfutils-devel@sourceware.org
|
|
|
|
The elfutils utilities are a new implementation of many of the
|
|
utilities found in binutils and consequently, the documentation for
|
|
most of the tools has been the the man pages for binutils. For example
|
|
you could refer to readelf's man page for instructions on
|
|
eu-readelf. This has been fine up until this point but as tools gain
|
|
new capabilities, they will need to have their own individual man
|
|
page. Forking the man pages from binutils is acceptable and the
|
|
current plan of action.
|
|
|
|
New utilities that do not have an analog in binutils can have their
|
|
initial man pages generated using a tool like help2man.
|
|
|
|
The C language interfaces for libelf, libdw, and libdwfl are in
|
|
particular need of documentation. The aspirational goal is write these
|
|
in sphinx. |