From 4b8c90bce0daf5af37921abeee997c4ba68994d7 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Mon, 20 Nov 2017 16:10:38 +1100 Subject: [PATCH] doc: Unify the two sections about the "dialout" group on Linux An addition to https://github.com/espressif/esp-idf/pull/1158 --- docs/get-started/establish-serial-connection.rst | 4 +++- docs/get-started/linux-setup.rst | 5 +---- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/get-started/establish-serial-connection.rst b/docs/get-started/establish-serial-connection.rst index f3e15250f1..929fe1ec24 100644 --- a/docs/get-started/establish-serial-connection.rst +++ b/docs/get-started/establish-serial-connection.rst @@ -54,10 +54,12 @@ MacOS :: ls /dev/cu.* +.. _linux-dialout-group: + Adding user to ``dialout`` on Linux ----------------------------------- -The currently logged user should have read and write access the serial port over USB. This is done by adding the user to ``dialout`` group with the following command:: +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:: sudo usermod -a -G dialout $USER diff --git a/docs/get-started/linux-setup.rst b/docs/get-started/linux-setup.rst index f4e624b22f..1c94510e1e 100644 --- a/docs/get-started/linux-setup.rst +++ b/docs/get-started/linux-setup.rst @@ -73,10 +73,7 @@ ESP32 toolchain for Linux is available for download from Espressif website: Permission issues /dev/ttyUSB0 ------------------------------ -With some Linux distributions you may get the ``Failed to open port /dev/ttyUSB0`` error message when flashing the ESP32. This can be solved by adding the current user to the ``dialout`` group, such as running the following command:: - - sudo adduser $USER dialout - +With some Linux distributions you may get the ``Failed to open port /dev/ttyUSB0`` error message when flashing the ESP32. :ref:`This can be solved by adding the current user to the dialout group`. Arch Linux Users