docs: fix minor issues in protobuf documentation#119
Merged
torrejonv merged 1 commit intoNov 5, 2025
Conversation
Fixed documentation issues identified in protobuf documentation audit: - alertProto.md: Removed test comment that was accidentally left in documentation - blockchainProto.md: Removed duplicate TOC entry for GetBlockHeadersFromCommonAncestorRequest Note: The audit also identified 3 undocumented API services that need documentation: - services/legacy/peer_api/peer_api.proto (PeerService with 7 RPC methods) - services/p2p/p2p_api/p2p_api.proto (PeerService with 9 RPC methods) - services/asset/asset_api/asset_api.proto (appears incomplete, needs investigation)
Contributor
|
🤖 Claude Code Review Status: Complete No issues found. This PR correctly removes a test comment and duplicate TOC entry from protobuf documentation. The changes are straightforward cleanup with no impact on functionality. |
oskarszoon
approved these changes
Nov 5, 2025
icellan
pushed a commit
that referenced
this pull request
May 13, 2026
Round-trip changes from the review comments left after the initial atomic-publication PR: - CodeQL #119: route the post-Del hash-prefix directory removal through os.Root so every path operation in this file stays inside the store sandbox. - renameTempFile: cross-platform semantics tightened. The ErrBlobAlreadyExists branch is documented as non-POSIX only (rename(2) atomically replaces on POSIX), and an allowOverwrite parameter lets non-POSIX callers explicitly remove the destination and retry instead of receiving a spurious already-exists error when they opted in to overwriting. - syncParentDirBestEffort: doc clarifies that the directory fsync is correctness-critical on ext4/xfs/btrfs after rename, not an optional "nice to have". "Best-effort" applies to failure handling, not to whether the call should run. - createTempSibling: replace big.NewInt(1<<63-1) with big.NewInt(math.MaxInt64) for readability. - fsyncMode opt-out via the ?fsyncMode=full|data|none URL parameter. Default remains full (current behaviour, safe on local disks). Operators running the file store over NFS or other network-attached storage can drop to data (skip the directory fsync) or none (skip both) to avoid the ~10-20 ms per-write cost; the trade-off is weakened crash safety as documented at the fsyncMode declaration. Tests added: - TestSetFromReader_ConcurrentWritersNeverExposePartialFinal: eight concurrent SetFromReader calls on the same key with AllowOverwrite. A reader poller asserts that any successful read of the final filename is byte-identical to the expected header+body payload, never a partial prefix. - TestRenameTempFile_OverwriteAndRejectSemantics: documents the observable POSIX behaviour (rename replaces on AllowOverwrite=true, errorOnOverwrite stops the call earlier when false) so a regression on either branch shows up in CI. - TestParseFsyncMode / TestNewWithFsyncMode: cover the new URL parameter (parsing, end-to-end Set/Get on each mode, invalid value rejection). - BenchmarkSetFromReader_FsyncModes: measures the cost of the atomic-publication path across three payload sizes and the three fsync modes. Local-disk numbers on an Apple M3 Max show fsyncModeFull at ~20 ms/op, fsyncModeData at ~10 ms/op, fsyncModeNone at <1 ms/op — gives operators a concrete frame for evaluating the trade-off on their target filesystem.
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.
Fixed documentation issues identified in protobuf documentation audit:
Note: The audit also identified 3 undocumented API services that need documentation: