Fix generated block size docs.#10482
Merged
Merged
Conversation
jmcarp
force-pushed
the
jmcarp/block-size-docs
branch
4 times, most recently
from
09a9afc to
8ca839a
Compare
jmcarp
force-pushed
the
jmcarp/block-size-docs
branch
from
8ca839a to
0672d1d
Compare
Contributor
|
-32k means the generation went wrong. it should be treated as a rename |
jmcarp
force-pushed
the
jmcarp/block-size-docs
branch
from
0672d1d to
c5d0ad9
Compare
david-crespo
reviewed
Jun 3, 2026
| }, | ||
| "BlockSize": { | ||
| "title": "Disk block size in bytes", | ||
| "description": "Size of blocks for a disk. Valid values are: 512, 2048, or 4096.", |
Contributor
There was a problem hiding this comment.
We don't need to effectively repeat the title in the description. I think it would be ok if it was just "description": "Valid values are: 512, 2048, or 4096.".
david-crespo
approved these changes
Jun 3, 2026
Contributor
david-crespo
left a comment
david-crespo
left a comment
There was a problem hiding this comment.
Looks good to me. The versioning boilerplate is unfortunate but it's not complex and it seems unavoidable.
jmcarp
force-pushed
the
jmcarp/block-size-docs
branch
from
c5d0ad9 to
15bef26
Compare
Represent Disk::block_size as a BlockSize rather than a ByteCount, so that the generated spec and docs are correct. This is technically a breaking change, even though both BlockSize and ByteCount are u32, so most of the diff is versioning-related housekeeping.
jmcarp
force-pushed
the
jmcarp/block-size-docs
branch
from
15bef26 to
dbf8d34
Compare
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
2 participants
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.
Represent Disk::block_size as a BlockSize rather than a ByteCount, so that the generated spec and docs are correct. This is technically a breaking change, even though both BlockSize and ByteCount are u32, so most of the diff is versioning-related housekeeping.