From d16a17b01ae35a2ce0fb9796371ad8c700ddc39b Mon Sep 17 00:00:00 2001 From: Krzysztof Budzynski Date: Fri, 28 Aug 2020 20:23:17 +0800 Subject: [PATCH] docs: Add missing target setting in step 7 of Getting Started documentation --- docs/en/get-started/index.rst | 8 +++----- docs/zh_CN/get-started/index.rst | 4 +++- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/en/get-started/index.rst b/docs/en/get-started/index.rst index 490990736f..178734ffc9 100644 --- a/docs/en/get-started/index.rst +++ b/docs/en/get-started/index.rst @@ -2,8 +2,6 @@ Get Started *********** -{IDF_TARGET_CL:default = "esp32", esp32 = "esp32", esp32s2 = "esp32s2"} - :link_to_translation:`zh_CN:[中文]` This document is intended to help you set up the software development environment for the hardware based on the {IDF_TARGET_NAME} chip by Espressif. @@ -331,7 +329,7 @@ Linux and macOS .. code-block:: bash cd ~/esp/hello_world - idf.py set-target {IDF_TARGET_CL} + idf.py set-target {IDF_TARGET_PATH_NAME} idf.py menuconfig Windows @@ -340,10 +338,10 @@ Windows .. code-block:: batch cd %userprofile%\esp\hello_world - idf.py set-target {IDF_TARGET_CL} + idf.py set-target {IDF_TARGET_PATH_NAME} idf.py menuconfig -Setting the target with ``idf.py set-target {IDF_TARGET}`` should be done once, after opening a new project. If the project contains some existing builds and configuration, they will be cleared and initialized. The target may be saved in environment variable to skip this step at all. See :ref:`selecting-idf-target` for additional information. +Setting the target with ``idf.py set-target {IDF_TARGET_PATH_NAME}`` should be done once, after opening a new project. If the project contains some existing builds and configuration, they will be cleared and initialized. The target may be saved in environment variable to skip this step at all. See :ref:`selecting-idf-target` for additional information. If the previous steps have been done correctly, the following menu appears: diff --git a/docs/zh_CN/get-started/index.rst b/docs/zh_CN/get-started/index.rst index da4d36fdd3..24d85e4b60 100644 --- a/docs/zh_CN/get-started/index.rst +++ b/docs/zh_CN/get-started/index.rst @@ -317,6 +317,7 @@ Linux 和 MacOS 操作系统 .. code-block:: bash cd ~/esp/hello_world + idf.py set-target {IDF_TARGET_PATH_NAME} idf.py menuconfig Windows 操作系统 @@ -325,9 +326,10 @@ Windows 操作系统 .. code-block:: batch cd %userprofile%\esp\hello_world + idf.py set-target {IDF_TARGET_PATH_NAME} idf.py menuconfig -打开一个新项目后，应首先设置“目标”芯片 ``idf.py set-target {IDF_TARGET}``。注意，此操作将清除并初始化项目之前的编译和配置（如有）。 您也可以直接将“目标”配置为环境变量（此时可跳过该步骤）。更多信息，请见 :ref:`selecting-idf-target`。 +打开一个新项目后，应首先设置“目标”芯片 ``idf.py set-target {IDF_TARGET_PATH_NAME}``。注意，此操作将清除并初始化项目之前的编译和配置（如有）。 您也可以直接将“目标”配置为环境变量（此时可跳过该步骤）。更多信息，请见 :ref:`selecting-idf-target`。 如果之前的步骤都正确，则会显示下面的菜单：