-
Notifications
You must be signed in to change notification settings - Fork 5.3k
[libcpu][components] Add comprehensive Kconfig help descriptions #10944
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
base: master
Are you sure you want to change the base?
Conversation
|
|
…mponents Co-authored-by: Rbb666 <64397326+Rbb666@users.noreply.github.com>
📌 Code Review Assignment🏷️ Tag: componentsReviewers: Maihuanyi Changed Files (Click to expand)
🏷️ Tag: components_libcReviewers: GorrayLi mysterywolf Changed Files (Click to expand)
🏷️ Tag: components_lwpReviewers: xu18838022837 Changed Files (Click to expand)
📊 Current Review Status (Last Updated: 2025-11-18 01:44 CST)
📝 Review Instructions
|
|
@copilot components下面的子组件中的Kconfig内容也需要进行完善补充 |
Co-authored-by: Rbb666 <64397326+Rbb666@users.noreply.github.com>
Co-authored-by: Rbb666 <64397326+Rbb666@users.noreply.github.com>
已完成components子组件Kconfig帮助文本的完善工作。 Enhanced Kconfig help text for key component sub-modules:
Total: 120+ configuration options now have comprehensive help descriptions across all changes. |
|
@copilot 请递归检查components/下子组件中的Kconfig内容,并进行补充 |
Co-authored-by: Rbb666 <64397326+Rbb666@users.noreply.github.com>
Co-authored-by: Rbb666 <64397326+Rbb666@users.noreply.github.com>
已完成components/下所有子组件Kconfig的递归检查和补充工作。 Completed recursive enhancement of Kconfig files in components/ subdirectories: Enhanced Kconfig files (12 total):
Statistics:
All help descriptions include functionality, use cases, dependencies, performance trade-offs, and configuration recommendations. |
拉取/合并请求描述:(PR description)
为什么提交这份PR (why to submit this PR)
Issue #9838 identified that Kconfig files in
libcpu/andcomponents/lack comprehensive help text, making it difficult for developers to understand configuration options, their dependencies, use cases, and impact on system behavior. Following comprehensive feedback from @Rbb666 requesting recursive checking and enhancement of all component subdirectories, this PR provides extensive help text across libcpu and all major components subsystems.你的解决方案是什么 (what is your solution)
Added detailed help descriptions for 160+ configuration options across 12 key Kconfig files through comprehensive recursive checking of components/ subdirectories:
Phase 1: Core libcpu and main components
libcpu/Kconfig (~1,245 lines added, 61+ options documented):
libcpu/aarch64/Kconfig (~138 lines added, 7 options documented):
components/Kconfig (~93 lines added, 3 options):
components/mprotect/Kconfig (~140 lines added, 6 options):
Phase 2: Component sub-modules (addressing @Rbb666's feedback)
components/finsh/Kconfig (~600 lines added, 15+ options documented):
components/dfs/Kconfig (~500 lines added, 12+ options documented):
components/lwp/Kconfig (~800 lines added, 15+ options documented):
components/net/sal/Kconfig (~400 lines added, 7+ options documented):
Phase 3: POSIX layer (recursive check of components/)
components/libc/posix/Kconfig (~1,300 lines added, 16+ options documented):
components/libc/posix/ipc/Kconfig (~400 lines added, 4 options):
Phase 4: Advanced drivers (recursive check continued)
components/drivers/pic/Kconfig (~700 lines added, 8+ options documented):
components/drivers/ofw/Kconfig (~550 lines added, 4 options documented):
Total improvements:
Each help entry includes:
Example - before:
After:
请提供验证的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 upOriginal prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.