diff --git a/docs b/docs index dd628f3e..58574c07 160000 --- a/docs +++ b/docs @@ -1 +1 @@ -Subproject commit dd628f3e8e500d27e3b12b1f80269327b11e5ab0 +Subproject commit 58574c074149656f1cfc5290122251ea6a5344c6 diff --git a/scripts/98-openocd-udev.rules b/scripts/98-openocd-udev.rules index f3a50711..c6ff3083 100644 --- a/scripts/98-openocd-udev.rules +++ b/scripts/98-openocd-udev.rules @@ -1,4 +1,9 @@ # UDEV Rules for debug adapters/boards supported by OpenOCD + +# +# INSTALLATION +# + # # The latest version of this file may be found at: # https://github.com/platformio/platformio-core/blob/develop/scripts/98-openocd-udev.rules @@ -17,6 +22,11 @@ # sudo udevadm control --reload-rules # sudo udevadm trigger # +# Ubuntu/Debian users may need to add own “username” to the “dialout” group if +# they are not “root”, doing this issuing a +# sudo usermod -a -G dialout $USER +# sudo usermod -a -G plugdev $USER +# # After this file is installed, physically unplug and reconnect your adapter/board. ACTION!="add|change", GOTO="openocd_rules_end" diff --git a/scripts/99-platformio-udev.rules b/scripts/99-platformio-udev.rules index aa8e868f..7adfcf0c 100644 --- a/scripts/99-platformio-udev.rules +++ b/scripts/99-platformio-udev.rules @@ -12,6 +12,10 @@ # See the License for the specific language governing permissions and # limitations under the License. +# +# INSTALLATION +# + # UDEV Rules for PlatformIO supported boards, http://platformio.org/boards # # The latest version of this file may be found at: @@ -33,7 +37,8 @@ # # Ubuntu/Debian users may need to add own “username” to the “dialout” group if # they are not “root”, doing this issuing a -# sudo usermod -a -G dialout yourusername +# sudo usermod -a -G dialout $USER +# sudo usermod -a -G plugdev $USER # # After this file is installed, physically unplug and reconnect your board. diff --git a/scripts/docspregen.py b/scripts/docspregen.py index d6a7c21f..8b14713d 100644 --- a/scripts/docspregen.py +++ b/scripts/docspregen.py @@ -132,29 +132,29 @@ Packages .. warning:: **Linux Users**: - * Ubuntu/Debian users may need to add own "username" to the "dialout" - group if they are not "root", doing this issuing a - ``sudo usermod -a -G dialout yourusername``. - * Install "udev" rules file `99-platformio-udev.rules `_ - (an instruction is located in the file). - * Raspberry Pi users, please read this article - `Enable serial port on Raspberry Pi `__. + * Install "udev" rules file `99-platformio-udev.rules `_ + (an instruction is located inside a file). + * Raspberry Pi users, please read this article + `Enable serial port on Raspberry Pi `__. """) if platform == "teensy": lines.append(""" - **Windows Users:** Teensy programming uses only Windows built-in HID - drivers. When Teensy is programmed to act as a USB Serial device, - Windows XP, Vista, 7 and 8 require `this serial driver - `_ - is needed to access the COM port your program uses. No special driver - installation is necessary on Windows 10. + **Windows Users:** + + Teensy programming uses only Windows built-in HID + drivers. When Teensy is programmed to act as a USB Serial device, + Windows XP, Vista, 7 and 8 require `this serial driver + `_ + is needed to access the COM port your program uses. No special driver + installation is necessary on Windows 10. """) else: lines.append(""" - **Windows Users:** Please check that you have correctly installed USB - driver from board manufacturer + **Windows Users:** + Please check that you have a correctly installed USB driver from board + manufacturer """) return "\n".join(lines)