Merge branch 'docs/dialout_group_linux' into 'master'

docs(get-started): Adjusteded docs flashing part to be more user friendly Closes IDFGH-11199 See merge request espressif/esp-idf!26411
espressif · Oct 20, 2023 · 91da72e · 91da72e
2 parents 44fcbe2 + 9cc2132
commit 91da72e
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 12 deletions.
diff --git a/docs/en/get-started/establish-serial-connection.rst b/docs/en/get-started/establish-serial-connection.rst
@@ -229,8 +229,8 @@ macOS ::
 
 .. _linux-dialout-group:
 
-Adding User to ``dialout`` on Linux
------------------------------------
+Adding User to ``dialout`` or ``uucp`` on Linux
+-----------------------------------------------
 
 The currently logged user should have read and write access the serial port over USB. On most Linux distributions, this is done by adding the user to ``dialout`` group with the following command::
 

diff --git a/docs/en/get-started/start-project.rst b/docs/en/get-started/start-project.rst
@@ -53,7 +53,7 @@ For more information on ``idf.py`` arguments, see :ref:`idf.py`.
 
     The option ``flash`` automatically builds and flashes the project, so running ``idf.py build`` is not necessary.
 
-Encountered Issues While Flashing? See this :doc:`flashing-troubleshooting` page or :doc:`establish-serial-connection` for more detailed information.
+Encountered Issues While Flashing? See the "Additional Tips" below. You can also refer to :doc:`flashing-troubleshooting` page or :doc:`establish-serial-connection` for more detailed information.
 
 Normal Operation
 ~~~~~~~~~~~~~~~~
@@ -444,13 +444,14 @@ Now you are ready to try some other :idf:`examples`, or go straight to developin
     If building an example, please check the README file for the ``Supported Targets`` table. If this is present including {IDF_TARGET_NAME} target, or the table does not exist at all, the example will work on {IDF_TARGET_NAME}.
 
 
+
 Additional Tips
 ===============
 
-Permission Issues ``/dev/ttyUSB0``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Permission Denied Issue
+~~~~~~~~~~~~~~~~~~~~~~~~
 
-With some Linux distributions, you may get the ``Failed to open port /dev/ttyUSB0`` error message when flashing the {IDF_TARGET_NAME}. :ref:`This can be solved by adding the current user to the dialout group <linux-dialout-group>`.
+With some Linux distributions, you may get the error message similar to ``Could not open port <PORT>: Permission denied: '<PORT>'`` when flashing the {IDF_TARGET_NAME}. :ref:`This can be solved by adding the current user to the specific group <linux-dialout-group>`, such as ``dialout`` or ``uucp`` group.
 
 Python Compatibility
 ~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/zh_CN/get-started/establish-serial-connection.rst b/docs/zh_CN/get-started/establish-serial-connection.rst
@@ -229,8 +229,8 @@ macOS::
 
 .. _linux-dialout-group:
 
-在 Linux 中添加用户到 ``dialout``
------------------------------------
+在 Linux 中添加用户到 ``dialout`` 或 ``uucp`` 组
+--------------------------------------------------
 
 当前登录用户应当可以通过 USB 对串口进行读写操作。在多数 Linux 版本中，都可以通过以下命令，将用户添加到 ``dialout`` 组，从而获许读写权限::
 

diff --git a/docs/zh_CN/get-started/start-project.rst b/docs/zh_CN/get-started/start-project.rst
@@ -53,7 +53,7 @@
 
     勾选 ``flash`` 选项将自动编译并烧录工程，因此无需再运行 ``idf.py build``。
 
-若在烧录过程中遇到问题，请前往 :doc:`flashing-troubleshooting` 或 :doc:`establish-serial-connection` 获取更多详细信息。
+若在烧录过程中遇到问题，请参考下文中的“其他提示”。也可以前往 :doc:`flashing-troubleshooting` 或 :doc:`establish-serial-connection` 获取更多详细信息。
 
 常规操作
 ~~~~~~~~~~~~~~~~
@@ -444,13 +444,14 @@
 	在编译示例程序前请查看 README 文件中 ``Supported Targets`` 表格。如果表格中包含 {IDF_TARGET_NAME}， 或者不存在这个表格，那么即表示 {IDF_TARGET_NAME} 支持这个示例程序。
 
 
+
 其他提示
 ===============
 
-权限问题 /dev/ttyUSB0
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+权限问题
+~~~~~~~~~~~~~~~~~~~~~
 
-使用某些 Linux 版本向 {IDF_TARGET_NAME} 烧录固件时，可能会出现 ``Failed to open port /dev/ttyUSB0`` 错误消息。此时可以将用户添加至 :ref:`Linux Dialout 组<linux-dialout-group>`。
+使用某些 Linux 版本向 {IDF_TARGET_NAME} 烧录固件时，可能会出现类似 ``Could not open port <PORT>: Permission denied: '<PORT>'`` 错误消息。此时可以在 Linux 将用户添加至 :ref:`dialout 组或 uucp 组<linux-dialout-group>` 来解决此类问题。
 
 兼容的 Python 版本
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~