Skip to content

Commit f64a3bc

Browse files
committed
Added note about ELF program headers not being parsed.
1 parent 83df560 commit f64a3bc

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ Additionally, relevant [x64-specific extensions](https://refspecs.linuxfoundatio
7777

7878
In theory 32-bit ELF files are supported, but their support is not regularly exercised. Big endian ELF files are not supported unless your app is running on a big endian platform. Developers with more advanced needs might consider evaluating [LibObjectFile](https://github.com/xoofx/LibObjectFile) instead.
7979

80+
### Unsupported ELF features
81+
82+
[The program headers](https://refspecs.linuxfoundation.org/elf/gabi4+/ch5.pheader.html) (if present) are not parsed. However, their offset and size is exposed via `ElfFile.Header` for advanced users who wish to parse them manually.
83+
8084
## API Stability
8185

8286
This library primarily exists to support the librarian functionality in [Biohazrd](https://github.com/InfectedLibraries/Biohazrd). Not a ton of thought went into the API, especially for things not needed by Biohazrd. As such I might tweak the API to better support these needs as they evolve. I consider this library to be pretty niche, so if you use this library in a major way consider posting a discussion or [DMing me](https://twitter.com/pathogendavid) so I know to avoid breaking you.

0 commit comments

Comments
 (0)