xref: /aosp_15_r20/external/elfutils/doc/README (revision 7304104da70ce23c86437a01be71edd1a2d7f37e)
1*7304104dSAndroid Build Coastguard WorkerThe elfutils documentation is very much a work in
2*7304104dSAndroid Build Coastguard Workerprogress. Contributions are welcome.
3*7304104dSAndroid Build Coastguard WorkerPlease reports bugs at https://sourceware.org/bugzilla/
4*7304104dSAndroid Build Coastguard WorkerPlease send additions and patches to: [email protected]
5*7304104dSAndroid Build Coastguard Worker
6*7304104dSAndroid Build Coastguard WorkerThe elfutils utilities are a new implementation of many of the
7*7304104dSAndroid Build Coastguard Workerutilities found in binutils and consequently, the documentation for
8*7304104dSAndroid Build Coastguard Workermost of the tools has been the the man pages for binutils. For example
9*7304104dSAndroid Build Coastguard Workeryou could refer to readelf's man page for instructions on
10*7304104dSAndroid Build Coastguard Workereu-readelf. This has been fine up until this point but as tools gain
11*7304104dSAndroid Build Coastguard Workernew capabilities, they will need to have their own individual man
12*7304104dSAndroid Build Coastguard Workerpage. Forking the man pages from binutils is acceptable and the
13*7304104dSAndroid Build Coastguard Workercurrent plan of action.
14*7304104dSAndroid Build Coastguard Worker
15*7304104dSAndroid Build Coastguard WorkerNew utilities that do not have an analog in binutils can have their
16*7304104dSAndroid Build Coastguard Workerinitial man pages generated using a tool like help2man.
17*7304104dSAndroid Build Coastguard Worker
18*7304104dSAndroid Build Coastguard WorkerThe C language interfaces for libelf, libdw, and libdwfl are in
19*7304104dSAndroid Build Coastguard Workerparticular need of documentation. The aspirational goal is write these
20*7304104dSAndroid Build Coastguard Workerin sphinx.