Skip to content

Commit 4c4b25f

Browse files
committed
Merge branch 'docs/add_instructions_to_create_esp_folder_before_clone_esp-idf' into 'master'
Add a command to create an esp directory before cloning esp-idf DOC-346 Closes DOC-346 See merge request espressif/esp-idf!10003
2 parents 80969f5 + a5e5794 commit 4c4b25f

File tree

5 files changed

+21
-10
lines changed

5 files changed

+21
-10
lines changed

docs/en/get-started/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,10 @@ Some tools need to be installed on the computer before proceeding to the next st
145145
.. _Linux: ../get-started/linux-setup.html
146146
.. _Mac OS: ../get-started/macos-setup.html
147147

148+
.. note::
149+
150+
This guide uses the directory ``~/esp`` on Linux and macOS or ``%userprofile%\esp`` on Windows as an installation folder for ESP-IDF. You can use any directory, but you will need to adjust paths for the commands respectively. Keep in mind that ESP-IDF does not support spaces in paths.
151+
148152
.. _get-started-get-esp-idf:
149153

150154
Step 2. Get ESP-IDF
@@ -154,10 +158,6 @@ To build applications for the {IDF_TARGET_NAME}, you need the software libraries
154158

155159
To get ESP-IDF, navigate to your installation directory and clone the repository with ``git clone``, following instructions below specific to your operating system.
156160

157-
.. note::
158-
159-
This guide uses the directory ``~/esp`` on Linux and macOS or ``%userprofile%\esp`` on Windows as an installation folder for ESP-IDF. You can use any directory, but you will need to adjust paths for the commands respectively. Keep in mind that ESP-IDF does not support spaces in paths.
160-
161161
Linux and macOS
162162
~~~~~~~~~~~~~~~
163163

docs/en/get-started/windows-setup.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,12 @@ https://dl.espressif.com/dl/esp-idf-tools-setup-2.3.exe
3232

3333
The installer includes the cross-compilers, OpenOCD, cmake_ and Ninja_ build tool. The installer can also download and run installers for Python_ 3.7 and `Git For Windows`_ if they are not already installed on the computer.
3434

35-
The installer also offers to download one of the ESP-IDF release versions.
35+
The installer also offers to download one of the ESP-IDF release versions. Please choose a directory for downloading ESP-IDF. The recommended directory is ``%userprofile%\esp`` where ``%userprofile%`` is your home directory. If you do not have it yet, please run the following command to create a new one:
36+
37+
.. code-block:: batch
38+
39+
mkdir %userprofile%\esp
40+
3641
3742
Using the Command Prompt
3843
========================

docs/idf_extensions/gen_version_specific_includes.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
"git-clone-bash": """
1818
.. code-block:: bash
1919
20+
mkdir -p ~/esp
2021
cd ~/esp
2122
git clone %(clone_args)s--recursive https://github.com/espressif/esp-idf.git
2223
""",
@@ -70,6 +71,7 @@
7071
"git-clone-bash": """
7172
.. code-block:: bash
7273
74+
mkdir -p ~/esp
7375
cd ~/esp
7476
git clone %(clone_args)s--recursive https://github.com/espressif/esp-idf.git
7577
""",

docs/zh_CN/get-started/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,10 @@
141141
.. _Linux: ../get-started/linux-setup.html
142142
.. _Mac OS: ../get-started/macos-setup.html
143143

144+
.. note::
145+
146+
在本文档中,Linux 和 MacOS 操作系统中 ESP-IDF 的默认安装路径为 ``~/esp``;Windows 操作系统的默认路径为 ``%userprofile%\esp``。您也可以将 ESP-IDF 安装在任何其他路径下,但请注意在使用命令行时进行相应替换。注意,ESP-IDF 不支持带有空格的路径。
147+
144148
.. _get-started-get-esp-idf:
145149

146150

@@ -151,10 +155,6 @@
151155

152156
获取 ESP-IDF 的本地副本:打开终端,切换到您要保存 ESP-IDF 的工作目录,使用 ``git clone`` 命令克隆远程仓库。针对不同操作系统的详细步骤,请见下文。
153157

154-
.. note::
155-
156-
在本文档中,Linux 和 MacOS 操作系统中 ESP-IDF 的默认安装路径为 ``~/esp``;Windows 操作系统的默认路径为 ``%userprofile%\esp``。您也可以将 ESP-IDF 安装在任何其他路径下,但请注意在使用命令行时进行相应替换。注意,ESP-IDF 不支持带有空格的路径。
157-
158158
Linux 和 MacOS 操作系统
159159
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
160160

docs/zh_CN/get-started/windows-setup.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,11 @@ https://dl.espressif.com/dl/esp-idf-tools-setup-2.3.exe
3232

3333
本安装器可为您安装所需的交叉编译器、OpenOCD、cmake_ 和 Ninja_ 编译工具,以及一款 mconf-idf_ 配置工具。此外,本安装器还可在有需要时下载、运行 Python_ 3.7 和 `Git For Windows` 的安装器。
3434

35-
本安装器还可用于下载任意 ESP-IDF 发布版本。
35+
本安装器还可用于下载任意 ESP-IDF 发布版本。推荐将 ESP-IDF 下载到 ``%userprofile%\esp`` 目录下,其中 ``%userprofile%`` 代表家目录。可运行以下命令,创建 ``%userprofile%\esp``。
36+
37+
.. code-block:: batch
38+
39+
mkdir %userprofile%\esp
3640
3741
使用命令提示符
3842
========================

0 commit comments

Comments
 (0)