From aa364961d0d8e69f29efe39ab2c2f11fb461abb1 Mon Sep 17 00:00:00 2001 From: ShellAddicted Date: Fri, 11 Jan 2019 18:03:17 +0100 Subject: [PATCH 1/4] docs(en): dialout-linux added specific command for Arch linux the correct group is 'uucp' Merges https://github.com/espressif/esp-idf/pull/2940 --- docs/en/get-started-cmake/establish-serial-connection.rst | 4 ++++ docs/en/get-started/establish-serial-connection.rst | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/docs/en/get-started-cmake/establish-serial-connection.rst b/docs/en/get-started-cmake/establish-serial-connection.rst index 9fe4bf15ea..7ddf9bfb6a 100644 --- a/docs/en/get-started-cmake/establish-serial-connection.rst +++ b/docs/en/get-started-cmake/establish-serial-connection.rst @@ -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 instead 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. diff --git a/docs/en/get-started/establish-serial-connection.rst b/docs/en/get-started/establish-serial-connection.rst index 8a337af8f5..a9e4d753bf 100644 --- a/docs/en/get-started/establish-serial-connection.rst +++ b/docs/en/get-started/establish-serial-connection.rst @@ -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 instead 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. From 7fa8eb91dd132c2da677fcf30f52a748cce618f6 Mon Sep 17 00:00:00 2001 From: krzychb Date: Mon, 21 Jan 2019 06:25:05 +0100 Subject: [PATCH 2/4] Small updates of wording --- docs/en/get-started-cmake/establish-serial-connection.rst | 2 +- docs/en/get-started/establish-serial-connection.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/get-started-cmake/establish-serial-connection.rst b/docs/en/get-started-cmake/establish-serial-connection.rst index 7ddf9bfb6a..4c89accc84 100644 --- a/docs/en/get-started-cmake/establish-serial-connection.rst +++ b/docs/en/get-started-cmake/establish-serial-connection.rst @@ -67,7 +67,7 @@ The currently logged user should have read and write access the serial port over sudo usermod -a -G dialout $USER -on Arch linux instead this is done by adding the user to ``uucp`` group with the following command:: +on Arch Linux this is done by adding the user to ``uucp`` group with the following command:: sudo usermod -a -G uucp $USER diff --git a/docs/en/get-started/establish-serial-connection.rst b/docs/en/get-started/establish-serial-connection.rst index a9e4d753bf..7e0e3a91e1 100644 --- a/docs/en/get-started/establish-serial-connection.rst +++ b/docs/en/get-started/establish-serial-connection.rst @@ -82,7 +82,7 @@ The currently logged user should have read and write access the serial port over sudo usermod -a -G dialout $USER -on Arch linux instead this is done by adding the user to ``uucp`` group with the following command:: +on Arch Linux this is done by adding the user to ``uucp`` group with the following command:: sudo usermod -a -G uucp $USER From b47fda98f3b0f40c5c1ed09aacc00211d7458519 Mon Sep 17 00:00:00 2001 From: suda-morris <362953310@qq.com> Date: Mon, 21 Jan 2019 23:45:31 +0800 Subject: [PATCH 3/4] update translation of establish-serial-connection --- docs/zh_CN/get-started-cmake/establish-serial-connection.rst | 4 ++++ docs/zh_CN/get-started/establish-serial-connection.rst | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/docs/zh_CN/get-started-cmake/establish-serial-connection.rst b/docs/zh_CN/get-started-cmake/establish-serial-connection.rst index c030698f8f..f646db83e1 100644 --- a/docs/zh_CN/get-started-cmake/establish-serial-connection.rst +++ b/docs/zh_CN/get-started-cmake/establish-serial-connection.rst @@ -67,6 +67,10 @@ MacOS :: sudo usermod -a -G dialout $USER +在 Arch Linux 中，需要通过以下命令将用户添加到 ``uucp`` 组中:: + + sudo usermod -a -G uucp $USER + 请重新登录，确保串口读写权限可以生效。 diff --git a/docs/zh_CN/get-started/establish-serial-connection.rst b/docs/zh_CN/get-started/establish-serial-connection.rst index e9d8d3c4ec..b27c429625 100644 --- a/docs/zh_CN/get-started/establish-serial-connection.rst +++ b/docs/zh_CN/get-started/establish-serial-connection.rst @@ -61,6 +61,10 @@ MacOS :: sudo usermod -a -G dialout $USER +在 Arch Linux 中，需要通过以下命令将用户添加到 ``uucp`` 组中:: + + sudo usermod -a -G uucp $USER + 重新登录以确保串行端口的读写权限被启用。 From 1332d3ba9c13c4089dc86f273fce7e8829620597 Mon Sep 17 00:00:00 2001 From: Anton Maklakov Date: Thu, 24 Jan 2019 20:03:03 +0800 Subject: [PATCH 4/4] docs: Correct priorities in the PATH string Fixes https://github.com/espressif/esp-idf/pull/2944 --- docs/en/get-started-cmake/linux-setup.rst | 4 ++-- docs/en/get-started/linux-setup.rst | 4 ++-- docs/zh_CN/get-started-cmake/add-idf_path-to-profile.rst | 4 ++-- docs/zh_CN/get-started-cmake/linux-setup.rst | 4 ++-- docs/zh_CN/get-started/linux-setup.rst | 4 ++-- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/en/get-started-cmake/linux-setup.rst b/docs/en/get-started-cmake/linux-setup.rst index bc98abea10..c3f51c0a44 100644 --- a/docs/en/get-started-cmake/linux-setup.rst +++ b/docs/en/get-started-cmake/linux-setup.rst @@ -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. diff --git a/docs/en/get-started/linux-setup.rst b/docs/en/get-started/linux-setup.rst index e418bd224e..564fa63fad 100644 --- a/docs/en/get-started/linux-setup.rst +++ b/docs/en/get-started/linux-setup.rst @@ -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. diff --git a/docs/zh_CN/get-started-cmake/add-idf_path-to-profile.rst b/docs/zh_CN/get-started-cmake/add-idf_path-to-profile.rst index d05399794e..06d563916a 100644 --- a/docs/zh_CN/get-started-cmake/add-idf_path-to-profile.rst +++ b/docs/zh_CN/get-started-cmake/add-idf_path-to-profile.rst @@ -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` 小节开始阅读。 diff --git a/docs/zh_CN/get-started-cmake/linux-setup.rst b/docs/zh_CN/get-started-cmake/linux-setup.rst index fa657c5ba1..0180fb954c 100644 --- a/docs/zh_CN/get-started-cmake/linux-setup.rst +++ b/docs/zh_CN/get-started-cmake/linux-setup.rst @@ -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``，应该有具体的安装的主路径。 diff --git a/docs/zh_CN/get-started/linux-setup.rst b/docs/zh_CN/get-started/linux-setup.rst index 06caaa3403..0bd18e0a91 100644 --- a/docs/zh_CN/get-started/linux-setup.rst +++ b/docs/zh_CN/get-started/linux-setup.rst @@ -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``，应该有具体的安装的主路径。