mirror of
https://github.com/espressif/esp-idf.git
synced 2025-07-29 18:27:20 +02:00
Merge branch 'ci/add-kconfig-pre-commit' into 'master'
docs:fix spelling/"casing" of the word "Kconfig" Closes IDF-11284 See merge request espressif/esp-idf!39470
This commit is contained in:
@ -16,7 +16,7 @@ In context of ESP-IDF, configuration consists of several files, most importantly
|
||||
- ``sdkconfig.defaults`` file, containing user-defined default values for the configuration options.
|
||||
- ``sdkconfig.rename`` file, containing ``OLD_NAME NEW_NAME`` pairs of configuration names to ensure backward compatibility. This file is used primarily by component or ESP-IDF developers.
|
||||
|
||||
Configuration files can be divided into two groups: those primarily **defining** the configuration options and those containing the **values** of these options. First group includes ``Kconfig``, ``Kcofnig.projbuild`` and ``sdkconfig.rename`` files, second group includes ``sdkconfig``, ``sdkconfig.defaults``, ``sdkconfig.h`` and ``sdkconfig.cmake`` files. All the files will be described in the following sections.
|
||||
Configuration files can be divided into two groups: those primarily **defining** the configuration options and those containing the **values** of these options. First group includes ``Kconfig``, ``Kconfig.projbuild`` and ``sdkconfig.rename`` files, second group includes ``sdkconfig``, ``sdkconfig.defaults``, ``sdkconfig.h`` and ``sdkconfig.cmake`` files. All the files will be described in the following sections.
|
||||
|
||||
For more information about the configuration system in ESP-IDF, please refer to the :ref:`Configuration Overview <configuration-overview>`.
|
||||
|
||||
|
@ -30,6 +30,6 @@ Checklist before submitting a new example:
|
||||
* All code in the example is well structured and commented.
|
||||
* Any unnecessary code (old debugging logs, commented-out code, etc.) is removed from the example.
|
||||
* Options in the example (like network names, addresses, etc) are not hard-coded. Use configuration items if possible, or otherwise declare macros or constants.
|
||||
* Configuration items are provided in a ``KConfig.projbuild`` file with a menu named "Example Configuration". See existing example projects to see how this is done.
|
||||
* Configuration items are provided in a ``Kconfig.projbuild`` file with a menu named "Example Configuration". See existing example projects to see how this is done.
|
||||
* All original example code has a license header saying it is "in the public domain / CC0", and a warranty disclaimer clause. Alternatively, the example is licensed under Apache License 2.0. See existing examples for headers to adapt from.
|
||||
* Any adapted or third party example code has the original license header on it. This code must be licensed compatible with Apache License 2.0.
|
||||
|
@ -30,6 +30,6 @@
|
||||
- 示例项目中的所有代码结构良好,关键代码要有详细注释。
|
||||
- 示例项目中所有不必要的代码(旧的调试日志,注释掉的代码等)都必须清除掉。
|
||||
- 示例项目中使用的选项(比如网络名称,地址等)不得直接硬编码,应尽可能地使用配置项,或者定义为宏或常量。
|
||||
- 配置项可见 ``KConfig.projbuild`` 文件,该文件中包含一个名为 “Example Configuration” 的菜单。具体情况,请查看现有示例项目。
|
||||
- 配置项可见 ``Kconfig.projbuild`` 文件,该文件中包含一个名为 “Example Configuration” 的菜单。具体情况,请查看现有示例项目。
|
||||
- 所有的源代码都需要在文件开头指定许可信息(表示该代码是 ``in the public domain CC0``)和免责声明。或者,源代码也可以应用 ``Apache License 2.0`` 许可条款。请查看现有示例项目的许可信息和免责声明,并根据实际情况进行修改。
|
||||
- 任何第三方代码(无论是直接使用,还是进行了一些改进)均应保留原始代码中的许可信息,且这些代码的许可必须兼容 ``Apache License 2.0`` 协议。
|
||||
|
Reference in New Issue
Block a user