docs: add on-disk layout document about compressed_format#34
Open
SToPire wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR drafts a new on-disk layout specification document for EROFS's compressed format and links it into the existing on-disk format documentation tree. The draft covers compression-related superblock fields, per-algorithm configuration records, the compression map header, both full and compacted logical cluster index encodings, and several per-inode compression features (ztailpacking, big pcluster, interlaced pcluster, fragment modes). The Encoded Extents Mode section is intentionally left as TBD.
Changes:
- Add new
src/ondisk/compressed_format.mddescribing compression-related superblock fields, feature flags, per-algorithm configuration records, the compression map header, logical cluster index (full and compact), and per-inode compression features. - Register the new page under the
index.mdtoctree and add a short introductory bullet describing the compressed layout. - Cross-reference packed inode, metabox inode, and various optional compression features within the new document.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
| src/ondisk/index.md | Adds a bullet describing the compressed layout and registers compressed_format in the toctree. |
| src/ondisk/compressed_format.md | New 428-line spec covering compression superblock fields, feature flags, per-algorithm config records, map header, logical cluster index (full + compact), and per-inode compression features. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Assisted-by: Codex:GPT-5.5 Signed-off-by: Yifan Zhao <yifan.yfzhao@foxmail.com>
SToPire
force-pushed
the
to-be-merge-compress
branch
from
dab157e to
18c0e7d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Draft for erofs on-disk layout spec about compressed_format...
(Encoded Extents Mode is still WIP)