Updated terminology around xorbs and cas objects.#2272
Open
Conversation
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 updates the internal documentation of the xet package to reflect a recent pass to make "xorb" consistently refer to the data objects we use to store chunks, and "cas" consistently refer to the remote server / data store. Previously, both "xorb" and "cas" referred to the data object, which caused some confusion.
Note
Low Risk
Documentation-only changes that rename concepts/fields; low risk aside from potential reader confusion if any downstream code still uses the old names.
Overview
Standardizes Xet protocol documentation so "xorb" consistently refers to the on-disk chunk container object and "CAS" refers to the remote storage/service, removing prior mixed usage.
Updates the shard format spec and related upload/download/deduplication docs to rename
CAS Info→Xorb Info(including struct/field names likecas_info_offset→xorb_info_offset, andCASReconstruction*→XorbReconstruction*) and adjusts axet-coresource link inxorb.mdto the newxorb_objectpath.Written by Cursor Bugbot for commit b90b3a1. This will update automatically on new commits. Configure here.