TheCloud/dwarfs
1
0
Fork 0
mirror of https://github.com/mhx/dwarfs.git synced 2025-08-03 17:56:12 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs(dwarfs-format): update section index description (gh #264)

Browse Source
This commit is contained in:
Marcus Holland-Moritz 2025-05-18 13:05:47 +02:00 committed by mhx
parent abe06c6f5a
commit 15b5706a90
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/dwarfs-format.md
View File

@ -120,12 +120,14 @@ Currently, the following different section types are defined:
offset relative to the first section. That is, the section index
is independent of whether or not a header is present before the
first section. The whole point of the section index is to avoid
having to build an index by visiting all section headers.
In order to find the start of the section index, you only have
to read the last 64-bit value from the file, check if the upper
16 bits match the `SECTION_INDEX`, then add the image offset
(header size) to the lower 48 bits. At that position in the
file, you should find a valid section header for the section
having to build an index by visiting all section headers. Since
the offsets in the index are sorted, the section index is *always*
stored uncompressed, and the section infex *must* be the last
section, you can find the start of the section index by reading
the last 64-bit value from the image file, checking if the upper
16 bits match the `SECTION_INDEX` type, and then add the image
offset (header size) to the lower 48 bits. At that position in
the file, you should find a valid section header for the section
index.
- `HISTORY` (10):