Skip to content

[ISSUE #10819] Correct misleading CommitLog buffer comment - #10820

Merged
ShannonDing merged 2 commits into
apache:developfrom
fuyou001:codex/fix-10819-commitlog-comment
Aug 6, 2026
Merged

[ISSUE #10819] Correct misleading CommitLog buffer comment#10820
ShannonDing merged 2 commits into
apache:developfrom
fuyou001:codex/fix-10819-commitlog-comment

Conversation

@fuyou001

@fuyou001 fuyou001 commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Which Issue(s) This PR Fixes

Brief Description

Correct the misleading comment before byteBuffer.put(preEncodeBuffer) in DefaultAppendMessageCallback#doAppend(...).

The destination buffer belongs to the CommitLog append path and may be backed by the mapped byte buffer, the transient write buffer, or the shared staging buffer used by writeWithoutMmap. It is not a queue or ConsumeQueue buffer. The revised comment makes clear that this line appends an already encoded message to the CommitLog buffer.

This is a documentation-only change with no runtime behavior, API, protocol, configuration, or persisted-format impact.

How Did You Test This Change?

  • Ran git diff --check successfully.
  • No behavioral tests were added or run because only a source-code comment changed.

@fuyou001
fuyou001 marked this pull request as ready for review August 6, 2026 02:58
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 48.25%. Comparing base (2daf0e2) to head (0724d74).

Additional details and impacted files
@@              Coverage Diff              @@
##             develop   #10820      +/-   ##
=============================================
- Coverage      48.32%   48.25%   -0.08%     
+ Complexity     13516    13497      -19     
=============================================
  Files           1380     1380              
  Lines         101138   101138              
  Branches       13120    13120              
=============================================
- Hits           48876    48800      -76     
- Misses         46298    46353      +55     
- Partials        5964     5985      +21     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@RockteMQ-AI RockteMQ-AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Trivial comment-only fix — the old comment incorrectly referred to "queue buffer" when the code writes to the CommitLog buffer. The corrected comment accurately describes the operation.


Automated review by github-manager-bot

@ShannonDing
ShannonDing merged commit cbebac2 into apache:develop Aug 6, 2026
10 checks passed
@fuyou001
fuyou001 deleted the codex/fix-10819-commitlog-comment branch August 6, 2026 08:36

@RockteMQ-AI RockteMQ-AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary

Defensive fix with proper validation and test coverage. LGTM.


Automated review by github-manager-bot

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.

[Doc] Correct misleading buffer comment in CommitLog#doAppend

5 participants