Skip to content

Describe the storage record types in our own terms - #53

Merged
matrixarkai merged 1 commit into
mainfrom
oss/flat-write-path-and-crc32c
Aug 19, 2026
Merged

Describe the storage record types in our own terms#53
matrixarkai merged 1 commit into
mainfrom
oss/flat-write-path-and-crc32c

Conversation

@bjmeetsfo

@bjmeetsfo bjmeetsfo commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Wording-only follow-up to the storage record types already on main.

The descriptions now stand on their own rather than being framed as comparisons, and three test names say what they assert instead of what they were modelled on:

  • field_numbers_match_the_on_disk_log_item_layout
  • field_numbers_match_the_on_disk_index_log_layout
  • band_states_keep_their_on_disk_numbering

No behaviour change — comments, doc comments, and those three test identifiers. 74 passing in the touched areas.

Deliberately untouched:

  • serde alias attributes — on-disk backward compatibility; removing one stops existing data from being read.
  • configuration identifiers and environment variable names — renaming those is a breaking change for deployments, not a documentation fix.
  • our own type names, and ordinary English uses of the word reference.

@bjmeetsfo
bjmeetsfo requested a review from superhaiou as a code owner August 19, 2026 03:11
@bjmeetsfo
bjmeetsfo force-pushed the oss/flat-write-path-and-crc32c branch from 7bc49ae to 7e4a58d Compare August 19, 2026 05:57
@bjmeetsfo bjmeetsfo changed the title Storage: CRC32C record integrity, block pre-allocation, log record types Describe the storage record types in our own terms Aug 19, 2026
Wording-only follow-up covering the record types, completing the pass that
already went through the rest of the crate. Descriptions stand on their own
rather than being framed as comparisons, and three test names now say what they
assert instead of what they were modelled on:

  field_numbers_match_the_on_disk_log_item_layout
  field_numbers_match_the_on_disk_index_log_layout
  band_states_keep_their_on_disk_numbering

No behaviour change: comments, doc comments and those three test identifiers.

Deliberately untouched -- serde alias attributes (on-disk backward
compatibility; removing one stops existing data being read), configuration
identifiers and environment variable names (renaming those is a breaking change
for deployments), and our own type names.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@bjmeetsfo
bjmeetsfo force-pushed the oss/flat-write-path-and-crc32c branch from 7e4a58d to d034be5 Compare August 19, 2026 06:00
@matrixarkai
matrixarkai merged commit ba7b7cf into main Aug 19, 2026
3 of 5 checks passed
@matrixarkai
matrixarkai deleted the oss/flat-write-path-and-crc32c branch August 19, 2026 06:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants