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