Document Stone v1#112
Open
livingsilver94 wants to merge 11 commits intoAerynOS:mainfrom
Open
Conversation
b5f2d99 to
70ff8f8
Compare
70ff8f8 to
d391804
Compare
Member
|
Can the dev team take a look I'm not equipped to judge this documentation |
Member
|
@tarkah We kind of need your eyes on this when you have a few spare cycles. |
tarkah
reviewed
May 6, 2026
tarkah
left a comment
There was a problem hiding this comment.
Looks good to me! Just a couple small things.
| description: The format of the Content record | ||
| --- | ||
|
|
||
| The Content record contains a blob. Its size is indicated in they Payload sub-header, as this kind |
|
|
||
| |Value|Name|Description|Meaning of `source`| | ||
| |---|---|---|---| | ||
| | 1 | Regular | Regular file of data. |<a href="https://xxhash.com">XXH3_128bits</a> hash of the file.<br></br>The source is a hash because our package manager, Moss, uses a [CAS](https://en.wikipedia.org/wiki/Content-addressable_storage) to store files. | |
There was a problem hiding this comment.
Might be worth pointing out this hash is what allows us to match against the index record & therefore content slice.
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.
This PR documents the Stone v1 format.
I wrote this documentation by reading the old D code, our libstone-go library and crates/stone Rust crate. I've been careful not to miss anything, but there may be errors somewhere, or information may be partial, especially for the least used fields.