-
Notifications
You must be signed in to change notification settings - Fork 5.3k
[docs][utest]:Add standardized utest documentation to atomic_tc and mtsafe_kprint_tc #10945
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: kernelReviewers: GorrayLi ReviewSun hamburger-os lianux-mm wdfk-prog xu18838022837 Changed Files (Click to expand)
📊 Current Review Status (Last Updated: 2025-11-18 10:45 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 standardized documentation blocks to two kernel core utest files (atomic_tc.c and mtsafe_kprint_tc.c), addressing the documentation gap identified in issue #10895. The documentation follows a consistent template structure with test objectives, scenarios, verification metrics, dependencies, and expected results.
Key Changes:
- Added comprehensive documentation blocks describing test purpose, scenarios, and expected behavior
- Updated copyright year from 2021/2023 to 2025 in both files
- Added change log entries for the documentation additions
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| src/utest/atomic_tc.c | Added standardized documentation block describing atomic operations tests including functional API tests and multi-threaded stress tests |
| src/utest/mtsafe_kprint_tc.c | Added standardized documentation block describing the MT-safe kprintf stress test with 16 concurrent threads |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
h0bbl3s
left a comment
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.
Fixing some formatting
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.
Update copyright dates
Relates to #10895
拉取/合并请求描述:(PR description)
Added standardized Utest documentation to the Kernel Core Atomic Operations Test atomic_tc
Added standardized Utest documentation to the Kernel Core MT-Safe Kprint Test mtsafe_kprint_tc
为什么提交这份PR (why to submit this PR)
As stated in the linked task, documentation is missing from some utest source files.
I've been going through the source code during projects recently, and would like to contribute. This seems like a good place to start.
你的解决方案是什么 (what is your solution)
Do a detailed read-through of source and perform trial runs of tests,
then write documentation
当前拉取/合并请求的状态 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