alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-09-20 00:36:01 -04:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Merge branch 'bugfix/doc_updates_from_github' into 'master'

Browse Source 
Documenation updates from github

See merge request idf/esp-idf!4120
This commit is contained in:
Angus Gratton 2019-01-30 09:34:28 +08:00
commit 35a53453f1
9 changed files with 26 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/en/get-started-cmake/establish-serial-connection.rst
View File

@ -67,6 +67,10 @@ The currently logged user should have read and write access the serial port over
sudo usermod -a -G dialout $USER
on Arch Linux this is done by adding the user to ``uucp`` group with the following command::
sudo usermod -a -G uucp $USER
Make sure you re-login to enable read and write permissions for the serial port.

4
docs/en/get-started-cmake/linux-setup.rst
View File

@ -73,10 +73,10 @@ ESP32 toolchain for Linux is available for download from Espressif website:
printenv PATH
You are looking for similar result containing toolchain's path at the end of displayed string::
You are looking for similar result containing toolchain's path at the beginning of displayed string::
$ printenv PATH
/home/user-name/bin:/home/user-name/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin:/home/user-name/esp/xtensa-esp32-elf/bin
/home/user-name/esp/xtensa-esp32-elf/bin:/home/user-name/bin:/home/user-name/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin
Instead of ``/home/user-name`` there should be a home path specific to your installation.

4
docs/en/get-started/establish-serial-connection.rst
View File

@ -82,6 +82,10 @@ The currently logged user should have read and write access the serial port over
sudo usermod -a -G dialout $USER
on Arch Linux this is done by adding the user to ``uucp`` group with the following command::
sudo usermod -a -G uucp $USER
Make sure you re-login to enable read and write permissions for the serial port.

4
docs/en/get-started/linux-setup.rst
View File

@ -71,10 +71,10 @@ ESP32 toolchain for Linux is available for download from Espressif website:
printenv PATH
You are looking for similar result containing toolchain's path at the end of displayed string::
You are looking for similar result containing toolchain's path at the beginning of displayed string::
$ printenv PATH
/home/user-name/bin:/home/user-name/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin:/home/user-name/esp/xtensa-esp32-elf/bin
/home/user-name/esp/xtensa-esp32-elf/bin:/home/user-name/bin:/home/user-name/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin
Instead of ``/home/user-name`` there should be a home path specific to your installation.

4
docs/zh_CN/get-started-cmake/add-idf_path-to-profile.rst
View File

@ -43,7 +43,7 @@ Linux 和 MacOS 操作系统
要设置 ``IDF_PATH``，并在 PATH 中添加 ``idf.py``，请将以下两行代码增加至你的 ``~/.profile`` 文件中::
export IDF_PATH=~/esp/esp-idf
export PATH="$PATH:$IDF_PATH/tools"
export PATH="$IDF_PATH/tools:$PATH"
.. note::
@ -70,6 +70,6 @@ Linux 和 MacOS 操作系统
如果你不想进行有关 ``IDF_PATH`` 或 ``PATH`` 的修改设置，你可以在每次重启或退出后在终端中手动输入::
export IDF_PATH=~/esp/esp-idf
export PATH="$PATH:$IDF_PATH/tools"
export PATH="$IDF_PATH/tools:$PATH"
如果你在安装 ESP32 开发的软件时，从 :ref:`get-started-setup-path-cmake` 小节跳到了这里，请返回 :ref:`get-started-start-project-cmake` 小节开始阅读。

4
docs/zh_CN/get-started-cmake/establish-serial-connection.rst
View File

@ -67,6 +67,10 @@ MacOS ::
sudo usermod -a -G dialout $USER
在 Arch Linux 中，需要通过以下命令将用户添加到 ``uucp`` 组中::
sudo usermod -a -G uucp $USER
请重新登录，确保串口读写权限可以生效。

4
docs/zh_CN/get-started-cmake/linux-setup.rst
View File

@ -73,10 +73,10 @@ Linux 版的 ESP32 工具链可以从 Espressif 的网站下载：
printenv PATH
检查一下字符串的末尾是否包含类似的工具链的路径::
检查字符串的开头是否包含类似的工具链路径::
$ printenv PATH
/home/user-name/bin:/home/user-name/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin:/home/user-name/esp/xtensa-esp32-elf/bin
/home/user-name/esp/xtensa-esp32-elf/bin:/home/user-name/bin:/home/user-name/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin
除了 ``/home/user-name``，应该有具体的安装的主路径。

4
docs/zh_CN/get-started/establish-serial-connection.rst
View File

@ -61,6 +61,10 @@ MacOS ::
sudo usermod -a -G dialout $USER
在 Arch Linux 中，需要通过以下命令将用户添加到 ``uucp`` 组中::
sudo usermod -a -G uucp $USER
重新登录以确保串行端口的读写权限被启用。

4
docs/zh_CN/get-started/linux-setup.rst
View File

@ -74,10 +74,10 @@ Linux 版的 ESP32 工具链可以从 Espressif 的网站下载：
printenv PATH
检查一下字符串的末尾是否包含类似的工具链的路径： ::
检查字符串的开头是否包含类似的工具链路径::
$ printenv PATH
/home/user-name/bin:/home/user-name/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin:/home/user-name/esp/xtensa-esp32-elf/bin
/home/user-name/esp/xtensa-esp32-elf/bin:/home/user-name/bin:/home/user-name/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin
除了 ``/home/user-name``，应该有具体的安装的主路径。