diff --git a/docs/_static/esp-idf-installer-command-prompt.png b/docs/_static/esp-idf-installer-command-prompt.png new file mode 100644 index 0000000000..997a97d29f Binary files /dev/null and b/docs/_static/esp-idf-installer-command-prompt.png differ diff --git a/docs/_static/esp-idf-installer-screenshot.png b/docs/_static/esp-idf-installer-screenshot.png new file mode 100644 index 0000000000..80520e0109 Binary files /dev/null and b/docs/_static/esp-idf-installer-screenshot.png differ diff --git a/docs/en/api-guides/freertos-smp.rst b/docs/en/api-guides/freertos-smp.rst index 0ac01048e5..cfd4c0e041 100644 --- a/docs/en/api-guides/freertos-smp.rst +++ b/docs/en/api-guides/freertos-smp.rst @@ -14,7 +14,7 @@ Overview The ESP-IDF FreeRTOS is a modified version of vanilla FreeRTOS which supports symmetric multiprocessing (SMP). ESP-IDF FreeRTOS is based on the Xtensa port -of FreeRTOS v8.2.0. This guide outlines the major differences between vanilla +of FreeRTOS v10.2.0. This guide outlines the major differences between vanilla FreeRTOS and ESP-IDF FreeRTOS. The API reference for vanilla FreeRTOS can be found via https://www.freertos.org/a00106.html diff --git a/docs/en/api-reference/system/freertos_additions.rst b/docs/en/api-reference/system/freertos_additions.rst index 35774c20c9..189611c0a0 100644 --- a/docs/en/api-reference/system/freertos_additions.rst +++ b/docs/en/api-reference/system/freertos_additions.rst @@ -4,7 +4,7 @@ FreeRTOS Additions Overview -------- -ESP-IDF FreeRTOS is based on the Xtensa port of FreeRTOS v8.2.0 with significant modifications +ESP-IDF FreeRTOS is based on the Xtensa port of FreeRTOS v10.2.0 with significant modifications for SMP compatibility (see :doc:`ESP-IDF FreeRTOS SMP Changes<../../api-guides/freertos-smp>`). However various features specific to ESP-IDF FreeRTOS have been added. The features are as follows: diff --git a/docs/en/get-started/windows-setup.rst b/docs/en/get-started/windows-setup.rst index fb0f610fb7..534a5e88f5 100644 --- a/docs/en/get-started/windows-setup.rst +++ b/docs/en/get-started/windows-setup.rst @@ -47,12 +47,28 @@ The installer also downloads one of the ESP-IDF release versions, or offers to u mkdir %userprofile%\esp +At the end of installation, if you checkout ``Run ESP-IDF Command Prompt (cmd.exe)``, a new Windows Power Shell, i.e. the ESP-IDF Command Prompt will pop up. + +.. figure:: ../../_static/esp-idf-installer-screenshot.png + :align: center + :alt: Completing the ESP-IDF Tools Setup Wizard with Run ESP-IDF Command Prompt (cmd.exe) + :figclass: align-center + + Completing the ESP-IDF Tools Setup Wizard with Run ESP-IDF Command Prompt (cmd.exe) + +.. figure:: ../../_static/esp-idf-installer-command-prompt.png + :align: center + :alt: ESP-IDF Command Prompt + :figclass: align-center + + ESP-IDF Command Prompt + Using the Command Prompt ======================== For the remaining Getting Started steps, we're going to use the Windows Command Prompt. -ESP-IDF Tools Installer creates a shortcut in the Start menu to launch the ESP-IDF Command Prompt. This shortcut launches the Command Prompt (cmd.exe) and runs ``export.bat`` script to set up the environment variables (``PATH``, ``IDF_PATH`` and others). Inside this command prompt, all the installed tools are available. +ESP-IDF Tools Installer also creates a shortcut in the Start menu to launch the ESP-IDF Command Prompt. This shortcut launches the Command Prompt (cmd.exe) and runs ``export.bat`` script to set up the environment variables (``PATH``, ``IDF_PATH`` and others). Inside this command prompt, all the installed tools are available. Note that this shortcut is specific to the ESP-IDF directory selected in the ESP-IDF Tools Installer. If you have multiple ESP-IDF directories on the computer (for example, to work with different versions of ESP-IDF), you have two options to use them: diff --git a/docs/zh_CN/contribute/documenting-code.rst b/docs/zh_CN/contribute/documenting-code.rst index 6d51742805..9cbfe34070 100644 --- a/docs/zh_CN/contribute/documenting-code.rst +++ b/docs/zh_CN/contribute/documenting-code.rst @@ -492,7 +492,7 @@ Doxygen 的安装取决于操作系统: 运行该命令后,系统将为 ESP-IDF 中所有可支持的语言和目标生成文档。这一过程将需要一些时间,但各文档会并行进行,速度取决于系统中 CPU 内核的个数(可通过 ``--sphinx-parallel-builds`` 选项修改该进程,详情可见 ``./build_docs.py --help``)。 -如需生成某一语言的单个文档,运行:: +如需生成某一目标 (esp32) 某一语种 (en) 的全部文档,即 ``en`` 文件夹下所有文档,运行:: ./build_docs.py -l en -t esp32 build @@ -504,7 +504,7 @@ Doxygen 的安装取决于操作系统: 生成文档子集 """""""""""""" -生成整个文档可能速度较慢,因此,也可以选择只生成你所需的某个子集。 +编译某一语言的所有文档可能速度较慢,因此,也可以选择只生成所需的某个文档或部分所选文档。 在指令中列出你需要生成的文档名称即可:: @@ -514,7 +514,7 @@ Doxygen 的安装取决于操作系统: ./build_docs.py -l en -t esp32 -i api-reference/peripherals/can.rst api-reference/peripherals/adc.rst build -还可以生成通配文档:: +还可以使用通配符,选择生成所有符合条件的文档:: ./build_docs.py -l en -t esp32 -i api-reference/peripherals/* build diff --git a/docs/zh_CN/get-started/windows-setup.rst b/docs/zh_CN/get-started/windows-setup.rst index 625b6c76e7..a83810580d 100644 --- a/docs/zh_CN/get-started/windows-setup.rst +++ b/docs/zh_CN/get-started/windows-setup.rst @@ -45,6 +45,22 @@ https://dl.espressif.com/dl/esp-idf-tools-setup-2.4.exe mkdir %userprofile%\esp +在安装结束时,如果勾选了 ``Run ESP-IDF Command Prompt (cmd.exe)``,则会弹出一个 Windows 命令提示符窗口,即 ESP-IDF 命令提示符窗口。 + +.. figure:: ../../_static/esp-idf-installer-screenshot.png + :align: center + :alt: 安装结束时,勾选运行 Run ESP-IDF Command Prompt (cmd.exe) + :figclass: align-center + + 安装结束时,勾选运行 Run ESP-IDF Command Prompt (cmd.exe) + +.. figure:: ../../_static/esp-idf-installer-command-prompt.png + :align: center + :alt: ESP-IDF Command Prompt + :figclass: align-center + + ESP-IDF 命令提示符窗口 + 使用命令提示符 ========================