drgn/libdrgn/elfutils/doc/README
Omar Sandoval 1cedca8ff4 Import elfutils
Based on:

c950e8a9 config: Fix spec file, add manpages and new GFDL license.

With the following patches:

configure: Add --disable-programs
configure: Add --disable-shared
configure: Fix -D_FORTIFY_SOURCE=2 check when CFLAGS contains -Wno-error
libcpu: compile i386_lex.c with -Wno-implicit-fallthrough

The plan is to stop relying on the distribution's version of elfutils
and instead ship our own. This gives us freedom to assume that we're
using the latest version and even ship our own patches (starting with a
few build system improvements). More details are in
scripts/update-elfutils.sh, which was used to generate this commit.
2019-09-05 01:04:33 -07:00

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.