-
Notifications
You must be signed in to change notification settings - Fork 5.3k
feature: utest: add standardized utest documentation to thread_tc #10924
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
📌 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-13 10:05 CST)
📝 Review Instructions
|
|
👋 感谢您对 RT-Thread 的贡献!Thank you for your contribution to RT-Thread! 为确保代码符合 RT-Thread 的编码规范,请在你的仓库中执行以下步骤运行代码格式化工作流(如果格式化CI运行失败)。 🛠 操作步骤 | Steps
完成后,提交将自动更新至 如有问题欢迎联系我们,再次感谢您的贡献!💐 |
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 comprehensive standardized documentation to the thread_tc.c unit test file, improving test clarity and maintainability by documenting test objectives, scenarios, verification metrics, dependencies, and expected results.
- Adds a detailed documentation block explaining the thread test case structure
- Updates the changelog with the new documentation addition
- Provides clear guidance for developers on test purpose, execution, and validation
src/utest/thread_tc.c
Outdated
| * - Time-slice scheduling distributes CPU time fairly among threads of the same priority (difference < 30%) | ||
| * | ||
| * Dependencies: | ||
| * - Enable Thread Test(RT-Thread Utestcases -> Kernel Core -> Thread Test) |
Copilot
AI
Nov 13, 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.
Missing space after "Test" in Dependencies section.
English: In line 47, there should be a space between "Test" and the opening parenthesis. It should read "Enable Thread Test (RT-Thread..." instead of "Enable Thread Test(RT-Thread...".
中文:在第47行中,"Test"和左括号之间应该有一个空格。应该是"Enable Thread Test (RT-Thread..."而不是"Enable Thread Test(RT-Thread..."。
| * - Enable Thread Test(RT-Thread Utestcases -> Kernel Core -> Thread Test) | |
| * - Enable Thread Test (RT-Thread Utestcases -> Kernel Core -> Thread Test) |
src/utest/thread_tc.c
Outdated
| * | ||
| * Change Logs: | ||
| * Date Author Notes | ||
| * 2021-09.01 yangjie the firet version |
Copilot
AI
Nov 13, 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.
Spelling error in the changelog: "firet" should be "first".
English: The word "firet" on line 8 is misspelled and should be "first". This typo exists in the original code (not introduced by this PR), but since line 10 is being added next to it, it would be good to fix this existing typo as well for consistency.
中文:第8行中的单词"firet"拼写错误,应该是"first"。这个拼写错误存在于原始代码中(不是本PR引入的),但由于第10行正在其旁边添加,建议同时修复这个现有的拼写错误以保持一致性。
| * 2021-09.01 yangjie the firet version | |
| * 2021-09.01 yangjie the first version |
Signed-off-by: Ze-Hou <yingkezhou@qq.com>
|
@Rbb666 老师,已经修改好了 |
拉取/合并请求描述:(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