feature: utest: add standardized utest documentation to messagequeue_tc#10946
feature: utest: add standardized utest documentation to messagequeue_tc#10946Rbb666 merged 1 commit intoRT-Thread:masterfrom
Conversation
📌 Code Review Assignment🏷️ Tag: kernelReviewers: GorrayLi ReviewSun hamburger-os lianux-mm wdfk-prog xu18838022837 Changed Files (Click to expand)
📊 Current Review Status (Last Updated: 2025-11-19 10:40 CST)
📝 Review Instructions
|
|
👋 感谢您对 RT-Thread 的贡献!Thank you for your contribution to RT-Thread! 为确保代码符合 RT-Thread 的编码规范,请在你的仓库中执行以下步骤运行代码格式化工作流(如果格式化CI运行失败)。 🛠 操作步骤 | Steps
完成后,提交将自动更新至 如有问题欢迎联系我们,再次感谢您的贡献!💐 |
There was a problem hiding this comment.
Pull Request Overview
This PR adds standardized documentation to the messagequeue_tc.c test file, following the established pattern used in other RT-Thread utest files. The documentation improves test case clarity and maintainability by providing comprehensive information about test objectives, scenarios, metrics, and dependencies.
Key Changes
- Added a comprehensive documentation block (lines 14-49) describing the message queue test case
- Updated the Change Logs section to record this documentation addition
- Documentation follows the standardized format used in other utest files (hooklist_tc.c, mem_tc.c, etc.)
src/utest/messagequeue_tc.c
Outdated
| * | ||
| * Dependencies: | ||
| * - Enable message queue priority (RT-Thread Kernel -> Inter-Thread communication | ||
| * -> Enable Enable message queue priority) |
There was a problem hiding this comment.
🟢 [Spelling/拼写]: Typo in word "Enable" / 单词"Enable"拼写错误
English: There is a duplicate "Enable" in the line "Enable Enable message queue priority". The first "Enable" should be removed.
中文:该行出现了重复的"Enable":"Enable Enable message queue priority"。应删除第一个"Enable"。
Suggested correction / 建议修正:
* - Enable message queue priority (RT-Thread Kernel -> Inter-Thread communication
* -> Enable message queue priority)| * -> Enable Enable message queue priority) | |
| * -> Enable message queue priority) |
Signed-off-by: Ze-Hou <yingkezhou@qq.com>
|
LGTM |
拉取/合并请求描述:(PR description)
Relates to #10895
[
为什么提交这份PR (why to submit this PR)
你的解决方案是什么 (what is your solution)
请提供验证的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