From 6b29118765bd2c42c39af0e452f8cc313be72fc1 Mon Sep 17 00:00:00 2001 From: mofeifei Date: Sat, 7 May 2022 17:15:18 +0800 Subject: [PATCH] docs: sync up lines for api-guides and get-started --- docs/en/api-guides/index.rst | 2 +- docs/en/get-started/index.rst | 2 +- docs/zh_CN/api-guides/startup.rst | 2 +- docs/zh_CN/api-guides/unit-tests.rst | 7 ++----- docs/zh_CN/get-started/index.rst | 4 +--- docs/zh_CN/get-started/windows-start-project.rst | 3 +++ 6 files changed, 9 insertions(+), 11 deletions(-) diff --git a/docs/en/api-guides/index.rst b/docs/en/api-guides/index.rst index a7e5e92fb5..592283b3f1 100644 --- a/docs/en/api-guides/index.rst +++ b/docs/en/api-guides/index.rst @@ -43,4 +43,4 @@ API Guides :SOC_WIFI_SUPPORTED: wifi :SOC_WIFI_SUPPORTED: wifi-security :SOC_SUPPORT_COEXISTENCE: coexist - reproducible-builds + reproducible-builds \ No newline at end of file diff --git a/docs/en/get-started/index.rst b/docs/en/get-started/index.rst index fe66e45a58..516c115711 100644 --- a/docs/en/get-started/index.rst +++ b/docs/en/get-started/index.rst @@ -159,6 +159,6 @@ For the manual procedure, please select according to your operating system. Build Your First Project ======================== -If you already have the ESP-IDF installed and not using IDE, you can build your first project from the command line following the :ref:`Start a Project on Windows ` or :ref:`Start a Project on Linux and macOS`. +If you already have the ESP-IDF installed and not using IDE, you can build your first project from the command line following the :ref:`Start a Project on Windows ` or :ref:`Start a Project on Linux and macOS `. .. _Stable version: https://docs.espressif.com/projects/esp-idf/en/stable/ diff --git a/docs/zh_CN/api-guides/startup.rst b/docs/zh_CN/api-guides/startup.rst index 2dac7f8bbf..282fd74c20 100644 --- a/docs/zh_CN/api-guides/startup.rst +++ b/docs/zh_CN/api-guides/startup.rst @@ -172,4 +172,4 @@ ESP-IDF 应用程序的入口是 :idf_file:`components/esp_system/port/cpu_start ``start_cpu_other_cores_default`` 函数做了一些与内核相关的系统初始化，然后等待 PRO CPU 启动 FreeRTOS 的调度器，启动完成后，它会执行 ``esp_startup_start_app_other_cores`` 函数，这是另一个默认为 ``esp_startup_start_app_other_cores_default`` 的弱链接函数。 - 默认情况下，``esp_startup_start_app_other_cores_default`` 只会自旋，直到 PRO CPU 上的调度器触发中断，以启动 APP CPU 上的 RTOS 调度器。 + 默认情况下，``esp_startup_start_app_other_cores_default`` 只会自旋，直到 PRO CPU 上的调度器触发中断，以启动 APP CPU 上的 RTOS 调度器。 \ No newline at end of file diff --git a/docs/zh_CN/api-guides/unit-tests.rst b/docs/zh_CN/api-guides/unit-tests.rst index e3bc78fc81..0f77c8a015 100644 --- a/docs/zh_CN/api-guides/unit-tests.rst +++ b/docs/zh_CN/api-guides/unit-tests.rst @@ -301,12 +301,9 @@ Mocks 要求 ^^^^^^^^^^^^ -生成 Mock 需要满足如下要求： +目前 Mock 只支持基于 Linux 主机的单元测试。生成 Mock 需要满足如下要求： -.. list:: - - 安装 ESP-IDF 及其所有要求 - - 安装 ``ruby`` - - 在 Linux 主机上需要安装 ``libbsd``，目前 Mock 只支持基于 Linux 主机的单元测试 +.. include:: inc/linux-host-requirements.rst 对组件进行 Mock diff --git a/docs/zh_CN/get-started/index.rst b/docs/zh_CN/get-started/index.rst index 43cc97f273..2bc0be1c3e 100644 --- a/docs/zh_CN/get-started/index.rst +++ b/docs/zh_CN/get-started/index.rst @@ -158,9 +158,7 @@ IDE 编译第一个工程 =================== -.. - Please translate -If you already have the ESP-IDF installed and not using IDE, you can build your first project from the command line following the :ref:`Start a Project on Windows ` or :ref:`Start a Project on Linux and macOS`. +如果您已经安装好 ESP-IDF 且没有使用集成开发环境 (IDE)，请在命令提示行中按照 :ref:`在 Windows 中开始创建工程 ` 或 :ref:`在 Linux 和 macOS 中开始创建工程 ` 编译第一个工程。 .. _Stable version: https://docs.espressif.com/projects/esp-idf/en/stable/ diff --git a/docs/zh_CN/get-started/windows-start-project.rst b/docs/zh_CN/get-started/windows-start-project.rst index e6c846c0ed..ec7e37ece0 100644 --- a/docs/zh_CN/get-started/windows-start-project.rst +++ b/docs/zh_CN/get-started/windows-start-project.rst @@ -42,6 +42,9 @@ 请进入 ``hello_world`` 目录，设置 {IDF_TARGET_NAME} 为目标芯片，然后运行工程配置工具 ``menuconfig``。 +Windows +~~~~~~~ + .. code-block:: batch cd %userprofile%\esp\hello_world