From 6b8420e877c5d776916a8c17b08aebd5c138fe4a Mon Sep 17 00:00:00 2001 From: daiziyan Date: Mon, 21 Feb 2022 17:20:27 +0800 Subject: [PATCH] docs: updated CN translation for using-debugger, windows-setup, resources and index --- docs/en/api-reference/storage/fatfs.rst | 3 ++- docs/zh_CN/api-guides/jtag-debugging/using-debugger.rst | 2 +- docs/zh_CN/api-reference/storage/fatfs.rst | 3 ++- docs/zh_CN/get-started/start-project.rst | 2 +- docs/zh_CN/get-started/windows-setup.rst | 1 - docs/zh_CN/index.rst | 1 - docs/zh_CN/resources.rst | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/en/api-reference/storage/fatfs.rst b/docs/en/api-reference/storage/fatfs.rst index 417b5f7674..c9a300114c 100644 --- a/docs/en/api-reference/storage/fatfs.rst +++ b/docs/en/api-reference/storage/fatfs.rst @@ -111,7 +111,8 @@ If you prefer generating partition without wear levelling support you can use `` ``fatfs_create_spiflash_image`` respectively ``fatfs_create_rawflash_image`` must be called from project's CMakeLists.txt. -If you decided because of any reason to use ``fatfs_create_rawflash_image`` (without wear levelling support) beware that it supports mounting only in read-only mode in the device. +If you decided because of any reason to use ``fatfs_create_rawflash_image`` (without wear levelling support), beware that it supports mounting only in read-only mode in the device. + The arguments of the function are as follows: diff --git a/docs/zh_CN/api-guides/jtag-debugging/using-debugger.rst b/docs/zh_CN/api-guides/jtag-debugging/using-debugger.rst index ddc902e05b..5e344569dc 100644 --- a/docs/zh_CN/api-guides/jtag-debugging/using-debugger.rst +++ b/docs/zh_CN/api-guides/jtag-debugging/using-debugger.rst @@ -228,7 +228,7 @@ 4. ``idf.py gdbgui`` - 启动 `gdbgui `_，在浏览器中打开调试器的前端界面。 + 启动 `gdbgui `_，在浏览器中打开调试器的前端界面。请在运行安装脚本时添加 "--enable-gdbgui" 参数，即运行 ``install.sh --enable-gdbgui``，从而确保支持 “gdbgui” 选项。 上述这些命令也可以合并到一起使用，``idf.py`` 会自动将后台进程（比如 openocd）最先运行，交互式进程（比如 GDB，monitor）最后运行。 diff --git a/docs/zh_CN/api-reference/storage/fatfs.rst b/docs/zh_CN/api-reference/storage/fatfs.rst index 3d4d5a4b87..47e6b06695 100644 --- a/docs/zh_CN/api-reference/storage/fatfs.rst +++ b/docs/zh_CN/api-reference/storage/fatfs.rst @@ -95,7 +95,7 @@ FatFs 分区生成器 该脚本是建立在分区生成器的基础上 (:component_file:`fatfsgen.py`)，目前除了可以生成分区外，也可以初始化磨损均衡。 -当前支持短文件名和 FAT12。未来计划实现长文件名以及 FAT16。 +当前支持短文件名、FAT12 和 FAT16。未来计划实现对长文件名的支持。 构建系统中使用 FatFs 分区生成器 @@ -113,6 +113,7 @@ FatFs 分区生成器 如果您决定使用 ``fatfs_create_rawflash_image`` （不支持磨损均衡），请注意它支持在设备中以只读模式安装。 + 该函数的参数如下： 1. partition - 分区的名称，需要在分区表中定义（如 :example_file:`storage/fatfsgen/partitions_example.csv`）。 diff --git a/docs/zh_CN/get-started/start-project.rst b/docs/zh_CN/get-started/start-project.rst index 03fb9b182b..d613f4a28c 100644 --- a/docs/zh_CN/get-started/start-project.rst +++ b/docs/zh_CN/get-started/start-project.rst @@ -6,7 +6,7 @@ 现在您已经具备了使用 ESP-IDF 的所有条件，接下来将介绍如何开始您的第一个工程。 -本指南将帮助您完成使用 ESP-IDF 的第一步。按照本指南，您将能够创建第一个工程、连接 {IDF_TARGET_NAME}、改变工程的配置，构建、烧录并监控该工程。 +本指南将帮助您完成使用 ESP-IDF 的第一步。按照本指南，您将能使用 {IDF_TARGET_NAME} 开始创建第一个工程，并构建、烧录和监控设备输出。 .. note:: diff --git a/docs/zh_CN/get-started/windows-setup.rst b/docs/zh_CN/get-started/windows-setup.rst index de46cb1471..9962acdd1b 100644 --- a/docs/zh_CN/get-started/windows-setup.rst +++ b/docs/zh_CN/get-started/windows-setup.rst @@ -125,7 +125,6 @@ ESP-IDF 工具安装器可在“开始”菜单中，创建一个打开 ESP-IDF vscode-setup ../api-guides/tools/idf-monitor -.. _MSYS2: https://www.msys2.org/ .. _CMake: https://cmake.org/download/ .. _Ninja: https://ninja-build.org/ .. _Python: https://www.python.org/downloads/windows/ diff --git a/docs/zh_CN/index.rst b/docs/zh_CN/index.rst index 30279af1b4..13bf1bc307 100644 --- a/docs/zh_CN/index.rst +++ b/docs/zh_CN/index.rst @@ -53,7 +53,6 @@ ESP-IDF 编程指南 :hidden: get-started/index - get-started/start-project api-reference/index hw-reference/index api-guides/index diff --git a/docs/zh_CN/resources.rst b/docs/zh_CN/resources.rst index 5ef0daa149..b4298a110e 100644 --- a/docs/zh_CN/resources.rst +++ b/docs/zh_CN/resources.rst @@ -19,7 +19,7 @@ * 您可以在 `ESP IoT Solution `_ 库中找到基于 ESP-IDF 的 `解决方案 `_、`应用实例 `_、`组件和驱动 `_ 等内容。多数文档均提供中英文版本。 -* 通过 Arduino 平台开发应用，请参考 `ESP32 Wi-Fi 芯片的 Arduino 内核 `_。 +* 通过 Arduino 平台开发应用，请参考 `ESP32、ESP32-S2 和 ESP32-C3 芯片的 Arduino 内核 `_。 * 关于 ESP32 的书籍列表，请查看 `乐鑫 `_ 网站。