docs: udpate CN translation for readme and build-system

Asc91 · May 11, 2022 · ca57e12 · ca57e12
1 parent dec3db6
commit ca57e12
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 185 deletions.
diff --git a/.gitlab/CODEOWNERS b/.gitlab/CODEOWNERS
@@ -56,6 +56,7 @@
 /CONTRIBUTING.md                      @esp-idf-codeowners/docs
 /Kconfig                              @esp-idf-codeowners/build-config
 /README*.md                           @esp-idf-codeowners/docs
+/SUPPORT_POLICY*.md                   @esp-idf-codeowners/docs
 /add_path.sh                          @esp-idf-codeowners/tools
 /conftest.py                          @esp-idf-codeowners/ci
 /export.*                             @esp-idf-codeowners/tools

diff --git a/README_CN.md b/README_CN.md
@@ -4,18 +4,25 @@
 
 ESP-IDF 是乐鑫官方推出的物联网开发框架，支持 Windows、Linux 和 macOS 操作系统。
 
+# ESP-IDF 版本支持期限
+
+![支持期限](https://dl.espressif.com/dl/esp-idf/support-periods.svg)
+
+- 请参考 [ESP-IDF 支持政策](SUPPORT_POLICY_CN.md) 以及 [相关文档](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/versions.html) 了解更多关于 ESP-IDF 版本的信息。
+- 请参考 [ESP-IDF 版本停止维护 (EOL) 公告](https://www.espressif.com/zh-hans/support/documents/advisories?keys=&field_type_of_advisory_tid%5B%5D=817)。
+
 # ESP-IDF 与乐鑫芯片
 
 下表总结了乐鑫芯片在 ESP-IDF 各版本中的支持状态，其中 ![alt text][supported] 代表已支持，![alt text][preview] 代表目前处于预览支持状态。预览支持状态通常有时间限制，而且仅适用于测试版芯片。请确保使用与芯片相匹配的 ESP-IDF 版本。
 
-|    芯片     |         v3.3           |           v4.1         |          v4.2          |         v4.3           |          v4.4          |          v5.0          |                                                            |
-|:----------- |:---------------------: | :---------------------:| :---------------------:| :---------------------:| :---------------------:| :---------------------:|:---------------------------------------------------------- |
-|ESP32        | ![alt text][supported] | ![alt text][supported] | ![alt text][supported] | ![alt text][supported] | ![alt text][supported] | ![alt text][supported] |                                                            |
-|ESP32-S2     |                        |                        | ![alt text][supported] | ![alt text][supported] | ![alt text][supported] | ![alt text][supported] |                                                            |
-|ESP32-C3     |                        |                        |                        | ![alt text][supported] | ![alt text][supported] | ![alt text][supported] |                                                            |
-|ESP32-S3     |                        |                        |                        |                        | ![alt text][supported] | ![alt text][supported] | [芯片发布公告](https://www.espressif.com/en/news/ESP32_S3) |
-|ESP32-C2     |                        |                        |                        |                        |                        | ![alt text][supported] |                                                            |
-|ESP32-H2     |                        |                        |                        |                        | ![alt text][preview]   | ![alt text][preview]   | [芯片发布公告](https://www.espressif.com/en/news/ESP32_H2) |
+|芯片         |          v4.1         |          v4.2          |         v4.3           |          v4.4          |          v5.0          |                                                                                      |
+|:----------- |:---------------------:| :---------------------:| :---------------------:| :---------------------:| :---------------------:|:------------------------------------------------------------------------------------ |
+|ESP32        |![alt text][supported] | ![alt text][supported] | ![alt text][supported] | ![alt text][supported] | ![alt text][supported] |                                                                                      |
+|ESP32-S2     |                       | ![alt text][supported] | ![alt text][supported] | ![alt text][supported] | ![alt text][supported] |                                                                                      |
+|ESP32-C3     |                       |                        | ![alt text][supported] | ![alt text][supported] | ![alt text][supported] |                                                                                      |
+|ESP32-S3     |                       |                        |                        | ![alt text][supported] | ![alt text][supported] | [芯片发布公告](https://www.espressif.com/en/news/ESP32_S3)                           |
+|ESP32-C2     |                       |                        |                        |                        | ![alt text][supported] | [芯片发布公告](https://blog.espressif.com/esp32-c2-and-why-it-matter-s-bcf4d7d0b2c6) |
+|ESP32-H2     |                       |                        |                        | ![alt text][preview]   | ![alt text][preview]   | [芯片发布公告](https://www.espressif.com/en/news/ESP32_H2)                           |
 
 [supported]: https://img.shields.io/badge/-%E6%94%AF%E6%8C%81-green "supported"
 [preview]: https://img.shields.io/badge/-%E9%A2%84%E8%A7%88-orange "preview"

diff --git a/SUPPORT_POLICY.md b/SUPPORT_POLICY.md
@@ -5,12 +5,9 @@ Support Period Policy
 
 * [中文版](./SUPPORT_POLICY_CN.md)
 
-Each ESP-IDF major and minor release (V4.1, V4.2, etc) is supported for
-30 months after the initial stable release date.
+Each ESP-IDF major and minor release (V4.1, V4.2, etc) is supported for 30 months after the initial stable release date.
 
-Supported means that the ESP-IDF team will continue to apply bug fixes,
-security fixes, etc to the release branch on GitHub, and periodically
-make new bugfix releases as needed.
+Supported means that the ESP-IDF team will continue to apply bug fixes, security fixes, etc to the release branch on GitHub, and periodically make new bugfix releases as needed.
 
 Support period is divided into "Service" and "Maintenance" period:
 
@@ -19,58 +16,36 @@ Support period is divided into "Service" and "Maintenance" period:
 | Service     | 12 months    | Yes                                   |
 | Maintenance | 18 months    | No                                    |
 
-During the Service period, bugfixes releases are more frequent. In some cases,
-support for new features may be added during the Service period (this is
-reserved for features which are needed to meet particular regulatory
-requirements or standards for new products, and which carry a very low risk of
-introducing regressions.)
+During the Service period, bugfixes releases are more frequent. In some cases, support for new features may be added during the Service period (this is reserved for features which are needed to meet particular regulatory requirements or standards for new products, and which carry a very low risk of introducing regressions.)
 
-During the Maintenance period, the version is still supported but only bugfixes
-for high severity issues or security issues will be applied.
+During the Maintenance period, the version is still supported but only bugfixes for high severity issues or security issues will be applied.
 
 Using an “In Service” version is recommended when starting a new project.
 
-Users are encouraged to upgrade all projects to a newer ESP-IDF release before
-the support period finishes and the release becomes End of Life (EOL). It is our
-policy to not continue fixing bugs in End of Life releases.
+Users are encouraged to upgrade all projects to a newer ESP-IDF release before the support period finishes and the release becomes End of Life (EOL). It is our policy to not continue fixing bugs in End of Life releases.
 
-Pre-release versions (betas, previews, `-rc` and `-dev` versions, etc)
-are not covered by any support period. Sometimes a particular feature is
-marked as "Preview" in a release, which means it is also not covered
-by the support period.
+Pre-release versions (betas, previews, `-rc` and `-dev` versions, etc) are not covered by any support period. Sometimes a particular feature is marked as "Preview" in a release, which means it is also not covered by the support period.
 
-ESP-IDF should be used in an up-to-date software environment. The operating system
-and other third-party tools should be supported by their maintainers.
-ESP-IDF cannot keep compatibility with unsupported third-party tools.
+ESP-IDF should be used in an up-to-date software environment. The operating system and other third-party tools should be supported by their maintainers. ESP-IDF cannot keep compatibility with unsupported third-party tools.
 
-The ESP-IDF Programming Guide has information about the
-[different versions of ESP-IDF](https://docs.espressif.com/projects/esp-idf/en/latest/versions.html)
-(major, minor, bugfix, etc).
+The ESP-IDF Programming Guide has information about the [different versions of ESP-IDF](https://docs.espressif.com/projects/esp-idf/en/latest/versions.html) (major, minor, bugfix, etc).
 
 Example
 -------
 
-ESP-IDF V3.3 was released in September 2019. It will be supported for 30 months
-until February 2022.
+ESP-IDF V3.3 was released in September 2019. It was supported for 30 months until February 2022.
 
 - The first V3.3 release was `v3.3` in September 2019.
-- The ESP-IDF team continues to backport bug fixes, security fixes,
-  etc to the release branch `release/v3.3`.
-- Periodically stable bugfix releases are created from the release
-  branch. For example `v3.3.1`, `v3.3.2`, etc. Users are encouraged to
-  always update to the latest bugfix release.
-- V3.3 bugfix releases continue until February 2022, when all V3.3.x
-  releases become End of Life.
+- The ESP-IDF team continues to backport bug fixes, security fixes, etc to the release branch `release/v3.3`.
+- Periodically stable bugfix releases are created from the release branch. For example `v3.3.1`, `v3.3.2`, etc. Users are encouraged to always update to the latest bugfix release.
+- V3.3 bugfix releases continue until February 2022, when all V3.3.x releases become End of Life.
 
 Existing Releases
 -----------------
 
-ESP-IDF release V4.1 and all newer releases will follow this support period
-policy. The support period for each release will be announced when the release
-is made.
+ESP-IDF release V4.1 and all newer releases will follow this support period policy. The support period for each release will be announced when the release is made.
 
-For releases made before the current support period policy was announced, the
-original support periods apply:
+For releases made before the current support period policy was announced, the original support periods apply:
 
 * ESP-IDF V4.0.x will be supported until October 2021
 * ESP-IDF V3.3.x will be supported until February 2022
@@ -79,8 +54,5 @@ original support periods apply:
 Policy History
 --------------
 
-* September 2019. This policy split ESP-IDF releases into Standard and Long Term
-  Support.
-* July 2020. All releases from now will have the same support period, which is
-  equal to the previous Long Term Support period. Added “In Service” period,
-  during which versions will receive more updates.
+* September 2019. This policy splits ESP-IDF releases into Standard and Long Term Support.
+* July 2020. All releases from now will have the same support period, which is equal to the previous Long Term Support period. Added “In Service” period, during which versions will receive more updates.
diff --git a/SUPPORT_POLICY_CN.md b/SUPPORT_POLICY_CN.md
@@ -3,6 +3,8 @@
 支持期限政策
 =====================
 
+* [英文版](./SUPPORT_POLICY.md)
+
 ESP-IDF 的每个主要版本和次要版本（如 V4.1、V4.2 等）自其首次稳定版本发布之日起将支持 30 个月。
 
 支持意味着 ESP-IDF 团队将会对 GitHub 上的发布分支继续进行 bug 修复、安全修补等，并根据需求定期发布新的 bugfix 版本。
@@ -18,12 +20,14 @@ ESP-IDF 的每个主要版本和次要版本（如 V4.1、V4.2 等）自其首
 
 在版本的维护周期内，版本仍然会继续支持，但仅会对严重问题或安全问题进行 bug 修复。
 
-建议在开始新项目的时候使用处于服务周期的版本。 
+建议在开始新项目的时候使用处于服务周期的版本。
 
 在某一版本支持期限结束，停止更新维护 (EOL) 前，建议用户升级所有项目至较新的 ESP-IDF 版本。根据《支持期限政策》，我们将停止对 EOL 版本进行 bug 修复。
 
 《支持期限政策》不适用于预发布版本（包括 beta、preview、-rc 和 -dev 版本等）。有时，在发布的版本中存在被标记为 "Preview" 的特定功能，则该功能也不在支持期限内。
 
+请确保在最新的软件环境中使用 ESP-IDF。操作系统和其他第三方工具应得到其维护者的支持。ESP-IDF 无法兼容不受支持的第三方工具。
+
 有关 [ESP-IDF 不同版本](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/versions.html)（主要版本、次要版本、bugfix 版本等）信息，可参阅《ESP-IDF 编程指南》。
 
 示例
@@ -45,11 +49,10 @@ ESP-IDF V4.1 及所有后续更新版本都将遵守该《支持期限政策》
 
 * ESP-IDF V4.0.x 将支持至 2021 年 10 月。
 * ESP-IDF V3.3.x 将支持至 2022 年 2 月。
-* ESP-IDF V3.1.x 和 V3.2.x 都将在 2020 年 10 月停止支持。
-* ESP-IDF v3.1.x 之前的版本已经停止支持。
-
+* ESP-IDF v3.3 之前的版本已经停止支持。
+
 政策历史
 --------------
 
-* 2019 年 9 月。该政策将 ESP-IDF 版本发布分为标准支持版本和长期支持版本。 
-* 2020 年 7 月。从现在开始，所有发布的版本都将有相同的支持周期，等同于之前的长期支持周期。新增了”服务周期“，期间版本的更新将较为频繁。
+* 2019 年 9 月。该政策将 ESP-IDF 版本发布分为标准支持版本和长期支持版本。
+* 2020 年 7 月。从现在开始，所有发布的版本都将有相同的支持周期，即之前的长期支持周期。新增了”服务周期“，期间版本的更新将较为频繁。
diff --git a/docs/en/api-guides/build-system.rst b/docs/en/api-guides/build-system.rst
@@ -313,7 +313,7 @@ There are other arguments that can be passed to ``idf_component_register``. Thes
 
 See `example component requirements`_ and  `example component CMakeLists`_ for more complete component ``CMakeLists.txt`` examples.
 
-.. _component variables:
+.. _preset_component_variables:
 
 Preset Component Variables
 --------------------------
@@ -692,7 +692,7 @@ Browse the :idf_file:`/tools/cmake/project.cmake` file and supporting functions
 Example Component CMakeLists
 ============================
 
-Because the build environment tries to set reasonable defaults that will work most of the time, component ``CMakeLists.txt`` can be very small or even empty (see `Minimal Component CMakeLists`_). However, overriding `component variables`_ is usually required for some functionality.
+Because the build environment tries to set reasonable defaults that will work most of the time, component ``CMakeLists.txt`` can be very small or even empty (see `Minimal Component CMakeLists`_). However, overriding `preset_component_variables`_ is usually required for some functionality.
 
 Here are some more advanced examples of component CMakeLists files.