[Cleanup] Properly terminate printed log lines #2935
Conversation
This file contains 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
Ensure that every Logprint(f) call is properly terminated with a newline (`\n`). Multi-line calls and daisy-chained calls can use a descriptor comment at the end of the code line (`/* Continued */`) to denote the log line is continued afterwards.
Ensures that all LogPrint() and LogPrintf() calls are properly terminated to avoid conjoined lines in the debug.log file.
panleone
approved these changes
Sep 17, 2024
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.
Ensure that every Logprint(f) call is properly terminated with a newline (
\n). Not doing this leads to conjoined lines in the log output, which should not happen. There are few instances where an unterminated call is intentional (ie, inside a for loop, with a final call at the end of the loop)Multi-line calls and daisy-chained calls can use a descriptor comment at the end of the code line (
/* Continued */) to denote the log line is continued afterwards.To prevent future instances of un-terminated log lines, add a linter specifically to check for this.