Rewritten: BZip3 Format Explanation #143
Merged
Conversation
This file contains 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
|
Looks great so far, thank you! |
Sewer56
force-pushed
the
improve-spec-docs
branch
from
0983809 to
0667a85
Compare
|
I accidentally swapped the 'frame' and 'file' headers around it seems yesterday. I resolved this. |
Sewer56
force-pushed
the
improve-spec-docs
branch
from
a05c0d4 to
4b9d031
Compare
kspalaiologos
approved these changes
Dec 14, 2024
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.
This is a slight rewrite of the bzip3 specification, in order to try making it a tiny bit simpler to follow.
The read order is linear, so rather than splitting up into separate files, you get File OR Frame header followed by the blocks.
The provided structures in the spec use 'pseudo-structs', similar to those found in 010Editor templates and ImHex patterns; rather than having to provide a paragraph explanation which may confuse users.
In addition, I've taken a bit of care to ensure that there is a clear separation between
file header/frame headerandblock/chunk. Notably, before theblock APIdocs page started with a description of the chunks, butbz3_encode_blockdoes not write a chunk. This is very clear in the docs now.All in all it's a first draft.
For any further changes, just commit them directly to the branch; no need for in-depth review; unless asking for comment.