docs(format): update LTX format specification - #92
Merged
corylanou merged 2 commits intoAug 12, 2026
Merged
Conversation
Document the current v3 header, flags, compressed page frames, page index, and trailer layout. Clarify that the file checksum covers decompressed page data and structural bytes instead of the raw compressed file stream. Refs #83
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: bf82b4a34a
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
benbjohnson
approved these changes
Aug 12, 2026
corylanou
deleted the
issue-83-docs-file-checksum-covers-the-logical-decompressed-page-stre
branch
August 12, 2026 16:14
corylanou
added a commit
that referenced
this pull request
Aug 12, 2026
The README rewritten in #92 says LTX carries no on-disk version field and a reader cannot determine the version from the file. Version 4 changes the magic to LTX4, so both statements became wrong on this branch, and nothing described encryption at all. Covers the LTX1/LTX4 split and why unencrypted output stays v3, the v4 header fields and encryption flag, the recipient block and key derivation, encrypted page frame layout and AAD binding, the page index auth tag, and the fact that encrypted files hash ciphertext so integrity is verifiable without a key.
This was referenced Aug 12, 2026
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.
Summary
Fixes #83
Test Plan