update comments in log moudule#632
Merged
hnwyllmm merged 1 commit intooceanbase:mainfrom Dec 11, 2025
Merged
Conversation
hnwyllmm
approved these changes
Dec 11, 2025
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request corrects misleading documentation in the Log module. The original comment for Log::operator<< incorrectly stated that it "won't output header information" when in fact it does emit full header details (timestamp, PID/TID, context, function, file, line) via the LOG_HEAD macro, just like other LOG_* macros.
Key Changes:
- Updated the Doxygen comment for
Log::operator<<to accurately reflect that it outputs standard log headers - Clarified when users should use
output()method for custom header handling
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
What problem were solved in this pull request?
Issue Number: close #551
Problem:
Log::operator<<incorrectly stated that it "won't output header information" (like function, file, line, etc.).Log::out(), which internally usesLOG_HEADmacro to print full header info (timestamp, PID/TID, context, function, file, line).This mismatch can mislead users into thinking
operator<<only writes raw message content, potentially causing confusion or misuse.What is changed and how it works?
Updated the Doxygen-style comment above
Log::operator<<template function insrc/common/log/log.h.New comment clearly states:
operator<<does output standard header info (time, pid/tid, ctx, func, file, line).output()/out()methods directly.Other information
No code logic changed — only comments correction.