drgn/libdrgn/elfutils/doc
Omar Sandoval 6f43fff627 Update elfutils with new stack frame interface
Rebase the existing patches and add the patches which extend the libdwfl
stack frame interface.

Based on:

47780c9e elflint, readelf: enhance error diagnostics

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
libdwfl: don't bother freeing frames outside of dwfl_thread_getframes
libdwfl: only use thread->unwound for initial frame
libdwfl: add interface for attaching to/detaching from threads
libdwfl: cache Dwfl_Module and Dwarf_Frame for Dwfl_Frame
libdwfl: add interface for evaluating DWARF expressions in a frame
2019-10-18 14:34:11 -07:00
..
ChangeLog Update elfutils with new stack frame interface 2019-10-18 14:34:11 -07:00
COPYING-GFDL Import elfutils 2019-09-05 01:04:33 -07:00
elf_begin.3 Import elfutils 2019-09-05 01:04:33 -07:00
elf_clone.3 Import elfutils 2019-09-05 01:04:33 -07:00
elf_getdata.3 Import elfutils 2019-09-05 01:04:33 -07:00
elf_update.3 Import elfutils 2019-09-05 01:04:33 -07:00
elfclassify.1 Import elfutils 2019-09-05 01:04:33 -07:00
elfutils.sgml Import elfutils 2019-09-05 01:04:33 -07:00
Makefile.am Import elfutils 2019-09-05 01:04:33 -07:00
readelf.1 Update elfutils with new stack frame interface 2019-10-18 14:34:11 -07:00
README Import elfutils 2019-09-05 01:04:33 -07:00

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.