Skip to content

docs: improve clarity in xattrs and chunked format documentation #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SKM2227229725 wants to merge 2 commits into
base: main
Choose a base branch
from
+5 −3
Open

docs: improve clarity in xattrs and chunked format documentation #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b34316
docs: improve clarity in xattrs and chunked format documentation
SKM2227229725 Mar 21, 2026
a961a65
Escfix: clarify e_name_index 0 usage per maintainer feedback
SKM2227229725 Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/ondisk/chunked_format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ inode offset 0x10) is interpreted as a chunk info summary:

| Bits | Width | Description |
|-------|-------|-------------|
| 0–4 | 5 | `chunkbits`: chunk size = `2^(blkszbits + chunkbits)` |
| 0–4 | 5 | `chunkbits`: chunk size = 2 to the power of (`blkszbits + chunkbits`) |
| 5 | 1 | `EROFS_CHUNK_FORMAT_INDEXES`: entry format selector (see below) |
| 6 | 1 | 48-bit layout specific; ignored for basic chunk-based inodes |
| 7–31 | 25 | Reserved; must be 0 |
Expand Down
6 changes: 4 additions & 2 deletions src/ondisk/xattrs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ When clear, the full byte selects one of the built-in short namespace prefixes:
| 4 | `trusted.` |
| 6 | `security.` |

`e_name_index` value `0` is used for arbitrary namespace xattrs and may be hidden at runtime.
Other values (such as `5`) are currently reserved unless defined by future format extensions.
(shared_xattr_area)=
## Shared Xattr Area

Expand All @@ -144,8 +146,8 @@ This section applies when `EROFS_FEATURE_INCOMPAT_XATTR_PREFIXES` is set.

When this feature is set, a table of `xattr_prefix_count` prefix entries is
present; see {ref}`xattr_prefix_table_placement` for where that table is stored.
Each entry has the following fixed header, padded together with the
variable-length `infix` payload to a 4-byte boundary:
Each entry has the following fixed header. The full entry, including the
variable-length `infix` payload, is padded to a 4-byte boundary.

| Offset | Size | Type | Name | Description |
|--------|------|-------|--------------|-------------|
Expand Down
Loading