xref: /aosp_15_r20/external/pigweed/pw_elf/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker.. _module-pw_elf:
2*61c4878aSAndroid Build Coastguard Worker
3*61c4878aSAndroid Build Coastguard Worker.. cpp:namespace-push:: pw::elf
4*61c4878aSAndroid Build Coastguard Worker
5*61c4878aSAndroid Build Coastguard Worker======
6*61c4878aSAndroid Build Coastguard Workerpw_elf
7*61c4878aSAndroid Build Coastguard Worker======
8*61c4878aSAndroid Build Coastguard Worker.. pigweed-module::
9*61c4878aSAndroid Build Coastguard Worker   :name: pw_elf
10*61c4878aSAndroid Build Coastguard Worker
11*61c4878aSAndroid Build Coastguard Worker``pw_elf`` provides support for interact with Executable and Linkable Format
12*61c4878aSAndroid Build Coastguard Worker(ELF) files.
13*61c4878aSAndroid Build Coastguard Worker
14*61c4878aSAndroid Build Coastguard Worker.. note::
15*61c4878aSAndroid Build Coastguard Worker
16*61c4878aSAndroid Build Coastguard Worker   This module is currently very limited, primarily supporting other Pigweed
17*61c4878aSAndroid Build Coastguard Worker   modules. Additional functionality (e.g. iterating sections, segments) may be
18*61c4878aSAndroid Build Coastguard Worker   added in the future.
19*61c4878aSAndroid Build Coastguard Worker
20*61c4878aSAndroid Build Coastguard Worker------
21*61c4878aSAndroid Build Coastguard WorkerGuides
22*61c4878aSAndroid Build Coastguard Worker------
23*61c4878aSAndroid Build Coastguard Worker
24*61c4878aSAndroid Build Coastguard WorkerRead an ELF section into a buffer
25*61c4878aSAndroid Build Coastguard Worker=================================
26*61c4878aSAndroid Build Coastguard Worker
27*61c4878aSAndroid Build Coastguard Worker.. literalinclude:: examples/reader.cc
28*61c4878aSAndroid Build Coastguard Worker   :language: cpp
29*61c4878aSAndroid Build Coastguard Worker   :linenos:
30*61c4878aSAndroid Build Coastguard Worker   :lines: 15-
31*61c4878aSAndroid Build Coastguard Worker
32*61c4878aSAndroid Build Coastguard Worker-------------
33*61c4878aSAndroid Build Coastguard WorkerAPI reference
34*61c4878aSAndroid Build Coastguard Worker-------------
35*61c4878aSAndroid Build Coastguard Worker.. doxygenclass:: pw::elf::ElfReader
36*61c4878aSAndroid Build Coastguard Worker   :members:
37