docs(utest): Add standardized documentation for “Scheduler Test”#11051
docs(utest): Add standardized documentation for “Scheduler Test”#11051Rbb666 merged 1 commit intoRT-Thread:masterfrom
Conversation
…tion, as tracked in issue [RT-Thread#10895](RT-Thread#10895). This leads to high maintenance costs, difficulty for new contributors, and inefficient code reviews. Solution: This patch adds the full, standardized documentation block to `sched_mtx_tc.c`, `sched_sem_tc.c`, `sched_thread_tc.c`, `sched_timed_mtx_tc.c` and `sched_timed_sem_tc.c` following the approved template. The documentation details: - Test Objectives and tested APIs - Test Scenarios - Verification Metrics - Dependencies - Test Execution command and Expected Results This makes the test case's purpose and behavior immediately clear to future maintainers and reviewers. Relates to [RT-Thread#10895](RT-Thread#10895) Signed-off-by: lhxj <2743257167@qq.com>
|
👋 感谢您对 RT-Thread 的贡献!Thank you for your contribution to RT-Thread! 为确保代码符合 RT-Thread 的编码规范,请在你的仓库中执行以下步骤运行代码格式化工作流(如果格式化CI运行失败)。 🛠 操作步骤 | Steps
完成后,提交将自动更新至 如有问题欢迎联系我们,再次感谢您的贡献!💐 |
📌 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-12-12 19:24 CST)
📝 Review Instructions
|
Relates to #10895
拉取/合并请求描述:(PR description)
[
为什么提交这份PR (why to submit this PR)
Most test cases in
src/utestlack standardized functional documentation, as tracked in issue #10895. This leads to high maintenance costs, difficulty for new contributors, and inefficient code reviews.你的解决方案是什么 (what is your solution)
This patch adds the full, standardized documentation block to
sched_mtx_tc.c,sched_sem_tc.c,sched_thread_tc.c,sched_timed_mtx_tc.candsched_timed_sem_tc.c, following the approved template.The documentation details:
This makes the test case's purpose and behavior immediately clear to future maintainers and reviewers.
请提供验证的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