补充了components\utilities\libadt中Kconfig的help内容 by hzy0117 · Pull Request #10960 · RT-Thread/rt-thread

hzy0117 · 2025-11-19T08:22:06Z

拉取/合并请求描述：(PR description)

[

为什么提交这份PR (why to submit this PR)

协助完成rtthread中components下的Kconfig的help内容补充
#10941

你的解决方案是什么 (what is your solution)

对部分组件的Kconfig增加了功能介绍，使用场景，启用后变化，要求配置的依赖项以及可能得副作用和注意事项

请提供验证的bsp和config (provide the config and bsp)

未更改BSP部分

BSP:未更改BSP部分

.config:无更改

action:无

]

当前拉取/合并请求的状态 Intent for your PR

必须选择一项 Choose one (Mandatory):

本拉取/合并请求是一个草稿版本 This PR is for a code-review and is intended to get feedback
本拉取/合并请求是一个成熟版本 This PR is mature, and ready to be integrated into the repo

代码质量 Code Quality：

我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:

已经仔细查看过代码改动的对比 Already check the difference between PR and old code
代码风格正确，包括缩进空格，命名及其他风格 Style guide is adhered to, including spacing, naming and other styles
没有垃圾代码，代码尽量精简，不包含#if 0代码，不包含已经被注释了的代码 All redundant code is removed and cleaned up
所有变更均有原因及合理的，并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
代码是高质量的 Code in this PR is of high quality
已经使用formatting 等源码格式化工具确保格式符合RT-Thread代码规范 This PR complies with RT-Thread code specification
如果是新增bsp, 已经添加ci检查到.github/ALL_BSP_COMPILE.json 详细请参考链接BSP自查

components/utilities/rtconfig.h

components/utilities/.config

…ig.h）

hzy0117 · 2025-11-19T11:13:06Z

已重新修正提交

hzy0117 · 2025-11-23T03:39:44Z

补充了components\utilities中所有Kconfig的help内容

Copilot

Pull request overview

This PR adds comprehensive help content to Kconfig configuration files across multiple RT-Thread components. The purpose is to improve documentation for configuration options by adding descriptions that explain functionality, use cases, dependencies, and default states.

Changes:

Added help text to configuration options in utilities components (utest, rt-link, libadt, ymodem, ulog, var_export, resource_id)
Added help text to network components (netdev, lwip, at)
Added help text to C++ and libc components (cplusplus, timezone/DST)

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
components/utilities/utest/utest/Kconfig	Added help text for RT_UTEST_SELF_PASS option
components/utilities/rt-link/Kconfig	Added help text for RT-Link protocol configuration options
components/utilities/libadt/Kconfig	Added comprehensive help text for ADT data structures (AVL, Bitmap, HashMap, Reference API)
components/utilities/Kconfig	Added help text for utilities like Ymodem, ULOG, UTEST, and resource management
components/net/netdev/Kconfig	Added help text for network device framework options
components/net/lwip/Kconfig	Added extensive help text for LwIP protocol stack configurations
components/net/at/Kconfig	Added help text for AT command framework options
components/libc/cplusplus/Kconfig	Added help text for C++ feature options
components/libc/compilers/common/Kconfig	Added help text for timezone and DST configuration

Comments suppressed due to low confidence (1)

components/utilities/libadt/Kconfig:1

The configuration name is incorrect. This should refer to RT_USING_LWIP203 instead of RT_USING_LWIP141 since it describes version 2.0.3.

English: The help text for RT_USING_LWIP203 incorrectly refers to RT_USING_LWIP141. This is a copy-paste error that should be corrected.

中文：RT_USING_LWIP203 的帮助文本错误地引用了 RT_USING_LWIP141。这是一个复制粘贴错误，应该更正。

menuconfig RT_USING_ADT

Copilot · 2026-01-15T05:45:10Z

components/utilities/utest/utest/Kconfig

    select RT_USING_UTEST
    default n
+    help
+        RT_UTEST_SELF_PASS controls whether the Utest framework's self-test functionality is enabled.    


There is trailing whitespace at the end of line 8. Remove the extra spaces after "enabled."

Suggested change

RT_UTEST_SELF_PASS controls whether the Utest framework's self-test functionality is enabled.

RT_UTEST_SELF_PASS controls whether the Utest framework's self-test functionality is enabled.

Copilot · 2026-01-15T05:45:10Z

components/net/lwip/Kconfig

            bool "lwIP v2.1.2"
-
+            help
+                RT_USING_LWIP141 is used to control the enabling of lwip version 2.1.2.


The configuration name is incorrect. This should refer to RT_USING_LWIP212 instead of RT_USING_LWIP141 since it describes version 2.1.2.

English: The help text for RT_USING_LWIP212 incorrectly refers to RT_USING_LWIP141. This is a copy-paste error that should be corrected.

中文：RT_USING_LWIP212 的帮助文本错误地引用了 RT_USING_LWIP141。这是一个复制粘贴错误，应该更正。

Copilot · 2026-01-15T05:45:10Z

components/net/lwip/Kconfig

        bool "Enable netif loopback"
        default n
+        help
+            LWIP_SO_LINGER enables the "Loopback" function of the LwIP network interface (netif).


The configuration name is incorrect. This help text describes loopback functionality but is placed under RT_LWIP_NETIF_LOOPBACK, not LWIP_SO_LINGER. Line 453 should refer to RT_LWIP_NETIF_LOOPBACK instead of LWIP_SO_LINGER.

English: The help text at line 453 incorrectly refers to LWIP_SO_LINGER when it should refer to RT_LWIP_NETIF_LOOPBACK. LWIP_SO_LINGER is about socket lingering behavior (lines 440-447), not loopback functionality.

中文：第 453 行的帮助文本错误地引用了 LWIP_SO_LINGER，应该引用 RT_LWIP_NETIF_LOOPBACK。LWIP_SO_LINGER 是关于套接字延迟关闭行为（第 440-447 行），而不是回环功能。

Suggested change

LWIP_SO_LINGER enables the "Loopback" function of the LwIP network interface (netif).

RT_LWIP_NETIF_LOOPBACK enables the "Loopback" function of the LwIP network interface (netif).

Copilot · 2026-01-15T05:45:11Z

components/net/at/Kconfig

        bool "Enable AT commands server"
        default n
+        help
+            AT_USING_SERVERAT is the AT server function switch.


"AT_USING_SERVERAT" appears to be a typo. It should be "AT_USING_SERVER" to match the actual configuration option name.

English: The configuration name has an extra "AT" at the end. Change "AT_USING_SERVERAT" to "AT_USING_SERVER".

中文：配置名称末尾多了一个 "AT"。应将 "AT_USING_SERVERAT" 改为 "AT_USING_SERVER"。

Suggested change

AT_USING_SERVERAT is the AT server function switch.

AT_USING_SERVER is the AT server function switch.

Copilot · 2026-01-15T05:45:11Z

components/net/at/Kconfig

+            help
+


The help text for AT_USING_SOCKET (line 88-89) is empty. This configuration option should have a description explaining what it does.

English: The help section for AT_USING_SOCKET is empty. Add a description explaining that it enables BSD Socket API support through AT commands.

中文：AT_USING_SOCKET 的帮助部分为空。应添加描述，说明它通过 AT 命令启用 BSD Socket API 支持。

Suggested change

help

help

AT_USING_SOCKET enables BSD Socket API support through the AT command framework.

When enabled, standard BSD socket APIs are translated into AT commands and sent to the underlying AT device to perform network operations.

It is disabled by default; enabling it will also enable RT_USING_SAL and SAL_USING_AT.

Copilot · 2026-01-15T05:45:11Z

components/net/at/Kconfig

+                    AT_USING_SOCKET is an AT socket adaptation switch within the AT command framework. Its core function is to enable the AT framework to provide a "BSD Socket standard API wrapper."
+                    When enabled, network modules adapted to AT commands can directly call the standard BSD Socket API without needing to concern themselves with the underlying AT command details.
+
+                    It is disabled by default; enabling it will also enable RT_USING_SAL and SAL_USING_AT.


The help text is placed under the wrong configuration option. This text describes AT_USING_SOCKET but is placed under AT_USING_SOCKET_SERVER (line 94). The description should be moved to the AT_USING_SOCKET option (lines 83-89).

English: The help text at lines 97-100 describes AT_USING_SOCKET functionality but is incorrectly placed under AT_USING_SOCKET_SERVER. Move this text to the correct location under AT_USING_SOCKET (line 88).

中文：第 97-100 行的帮助文本描述了 AT_USING_SOCKET 功能，但错误地放在了 AT_USING_SOCKET_SERVER 下。应将此文本移动到 AT_USING_SOCKET（第 88 行）下的正确位置。

Copilot · 2026-01-15T05:45:12Z

components/libc/cplusplus/Kconfig

+        help
+            RT_USING_CPP_WRAPPER is used to enable the C++ wrapper for the RT-Thread core API.

+            When this option is enabled(Off by default), RT-Thread provides an additional set of C++ code that encapsulates the underlying C API using classes and objects.


Missing space after "enabled" and before the opening parenthesis. Change "enabled(Off" to "enabled (Off".

English: Add a space between "enabled" and "(Off by default)".

中文：在 "enabled" 和 "(Off by default)" 之间添加空格。

Suggested change

When this option is enabled(Off by default), RT-Thread provides an additional set of C++ code that encapsulates the underlying C API using classes and objects.

When this option is enabled (Off by default), RT-Thread provides an additional set of C++ code that encapsulates the underlying C API using classes and objects.

Copilot · 2026-01-15T05:45:12Z

components/libc/cplusplus/Kconfig

        default n
-
+        help
+            RT_USING_CPP_EXCEPTIONS is used to enable C++ exception handling.


The help text for RT_USING_CPP_EXCEPTIONS is incomplete. It should mention that this feature is disabled by default and explain the implications (increased overhead, as noted in the option name).

English: The help text should mention that this is disabled by default and explain the overhead implications mentioned in the configuration name.

中文：帮助文本应该提到这在默认情况下是禁用的，并解释配置名称中提到的开销影响。

Suggested change

RT_USING_CPP_EXCEPTIONS is used to enable C++ exception handling.

RT_USING_CPP_EXCEPTIONS is used to enable C++ exception handling.

It is disabled by default. Enabling this option pulls in the C++ exception runtime support, which typically increases

code size (flash/ROM usage), RAM consumption, and may add extra runtime overhead for stack unwinding and exception

bookkeeping. On resource-constrained or strict real-time systems, this additional overhead should be evaluated carefully

before turning the option on.

Rbb666 · 2026-01-15T05:46:41Z

@hzy0117 还请根据AI建议修改下，谢谢

Rbb666 requested changes Nov 19, 2025

View reviewed changes

components/utilities/rtconfig.h Outdated Show resolved Hide resolved

components/utilities/.config Outdated Show resolved Hide resolved

补充了components\utilities\libadt中Kconfig的help内容（修正：移除不必要的.config和rtconf…

f508fe9

…ig.h）

hzy0117 force-pushed the Kconfig_for_help branch from ed727a7 to f508fe9 Compare November 19, 2025 11:10

补充了rt-thread\components\utilities下所有Kconfig中的配置项的help内容

fd14b79

补充了components/libc所有Kconfig的help内容

7a31c70

hzy0117 requested a review from mysterywolf as a code owner November 25, 2025 05:06

补充rt-thread\components\net下所有Kconfig的help内容 ref RT-Thread#10941

c6a8d92

Rbb666 requested a review from Copilot January 15, 2026 05:41

Copilot started reviewing on behalf of Rbb666 January 15, 2026 05:43 View session

Copilot AI reviewed Jan 15, 2026

View reviewed changes

	RT_UTEST_SELF_PASS controls whether the Utest framework's self-test functionality is enabled.
	RT_UTEST_SELF_PASS controls whether the Utest framework's self-test functionality is enabled.

	LWIP_SO_LINGER enables the "Loopback" function of the LwIP network interface (netif).
	RT_LWIP_NETIF_LOOPBACK enables the "Loopback" function of the LwIP network interface (netif).

	AT_USING_SERVERAT is the AT server function switch.
	AT_USING_SERVER is the AT server function switch.

-            help
+            help
+                AT_USING_SOCKET enables BSD Socket API support through the AT command framework.
+                When enabled, standard BSD socket APIs are translated into AT commands and sent to the underlying AT device to perform network operations.
+                It is disabled by default; enabling it will also enable RT_USING_SAL and SAL_USING_AT.

	When this option is enabled(Off by default), RT-Thread provides an additional set of C++ code that encapsulates the underlying C API using classes and objects.
	When this option is enabled (Off by default), RT-Thread provides an additional set of C++ code that encapsulates the underlying C API using classes and objects.

-            RT_USING_CPP_EXCEPTIONS is used to enable C++ exception handling.
+            RT_USING_CPP_EXCEPTIONS is used to enable C++ exception handling.
+            It is disabled by default. Enabling this option pulls in the C++ exception runtime support, which typically increases
+            code size (flash/ROM usage), RAM consumption, and may add extra runtime overhead for stack unwinding and exception
+            bookkeeping. On resource-constrained or strict real-time systems, this additional overhead should be evaluated carefully
+            before turning the option on.

Conversation

hzy0117 commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

拉取/合并请求描述：(PR description)

为什么提交这份PR (why to submit this PR)

你的解决方案是什么 (what is your solution)

请提供验证的bsp和config (provide the config and bsp)

当前拉取/合并请求的状态 Intent for your PR

代码质量 Code Quality：

Uh oh!

Uh oh!

Uh oh!

hzy0117 commented Nov 19, 2025

Uh oh!

hzy0117 commented Nov 23, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Rbb666 commented Jan 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hzy0117 commented Nov 19, 2025 •

edited

Loading