-
Notifications
You must be signed in to change notification settings - Fork 5.3k
feat(ulog): Add a one-time warning when the log line buffer is insufficient #10948
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
👋 感谢您对 RT-Thread 的贡献!Thank you for your contribution to RT-Thread! 为确保代码符合 RT-Thread 的编码规范,请在你的仓库中执行以下步骤运行代码格式化工作流(如果格式化CI运行失败)。 🛠 操作步骤 | Steps
完成后,提交将自动更新至 如有问题欢迎联系我们,再次感谢您的贡献!💐 |
📌 Code Review Assignment🏷️ Tag: componentsReviewers: @Maihuanyi Changed Files (Click to expand)
📊 Current Review Status (Last Updated: 2025-11-17 17:02 CST)
📝 Review Instructions
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a one-time warning mechanism to the ulog component to alert developers when log content exceeds the ULOG_LINE_BUF_SIZE buffer capacity. Currently, ulog silently truncates oversized logs, which can lead to incomplete debugging information.
Key Changes:
- Introduces a new static function
ulog_no_enough_buffer_printf()that prints a warning message only once using a static boolean flag - Integrates the warning function into both
ulog_formaterandulog_hex_formaterwhere log truncation occurs - Follows existing code patterns found elsewhere in the file (similar pattern at lines 606-612)
| rt_kprintf("Warning: There is not enough buffer to output the log," | ||
| " please increase the ULOG_LINE_BUF_SIZE option.\n"); |
Copilot
AI
Nov 17, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] [Spelling/拼写]: Minor wording improvement suggested for better English clarity.
English: While grammatically correct, "There is not enough buffer" is slightly awkward. It would be more natural to say "There is not enough buffer space" or "The buffer is not large enough". This would also make it more consistent and clear.
Note: This is better than the existing code at line 609 which uses "There is no enough buffer" (grammatically incorrect). Consider updating both messages together.
中文:虽然语法正确,但 "There is not enough buffer" 的表达略显不自然。建议改为 "There is not enough buffer space" 或 "The buffer is not large enough",这样会更加清晰自然。
注意:这已经比现有代码第 609 行的 "There is no enough buffer"(语法错误)要好。建议一起更新两处信息。
Suggested correction/建议修正:
rt_kprintf("Warning: There is not enough buffer space to output the log, "
"please increase the ULOG_LINE_BUF_SIZE option.\n");| rt_kprintf("Warning: There is not enough buffer to output the log," | |
| " please increase the ULOG_LINE_BUF_SIZE option.\n"); | |
| rt_kprintf("Warning: There is not enough buffer space to output the log, " | |
| "please increase the ULOG_LINE_BUF_SIZE option.\n"); |
|
LGTM |
拉取/合并请求描述:(PR description)
[
为什么提交这份PR (why to submit this PR)
你的解决方案是什么 (what is your solution)
Warning: There is not enough buffer to output the log, please increase the ULOG_LINE_BUF_SIZE option.
这样,开发者就能明确地知道日志被截断了,并根据提示去调整配置。
请提供验证的bsp和config (provide the config and bsp)
]
当前拉取/合并请求的状态 Intent for your PR
必须选择一项 Choose one (Mandatory):
代码质量 Code Quality:
我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:
#if 0代码,不包含已经被注释了的代码 All redundant code is removed and cleaned up