From 29e802575061ccf0e481644d980db3801345e378 Mon Sep 17 00:00:00 2001 From: Djordje Nedic Date: Mon, 6 Mar 2023 14:46:27 +0100 Subject: [PATCH 1/2] docs: Simplify OpenOCD udev rules instructions for manual Linux installation Instead of pointing the user to the OpenOCD documentation, we simply instruct them to copy a single file and point them directly to it. --- docs/en/api-guides/jtag-debugging/configure-builtin-jtag.rst | 2 ++ docs/en/api-guides/jtag-debugging/configure-ft2232h-jtag.rst | 2 +- docs/en/api-guides/jtag-debugging/configure-other-jtag.rst | 1 + 3 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/en/api-guides/jtag-debugging/configure-builtin-jtag.rst b/docs/en/api-guides/jtag-debugging/configure-builtin-jtag.rst index f83e6a539f..4a73926325 100644 --- a/docs/en/api-guides/jtag-debugging/configure-builtin-jtag.rst +++ b/docs/en/api-guides/jtag-debugging/configure-builtin-jtag.rst @@ -37,3 +37,5 @@ Configure USB Drivers JTAG communication should work on all supported platforms. Windows users might get `LIBUSB_ERROR_NOT_FOUND` errors. Please use version 2.8 (or newer) of the :ref:`get-started-windows-tools-installer` and select the driver "Espressif - WinUSB support for JTAG (ESP32-C3/S3)" in order to resolve this issue. If you don't want to re-run the installer then the same can be achieved with `idf-env `_ by running the following command from PowerShell:: Invoke-WebRequest 'https://dl.espressif.com/dl/idf-env/idf-env.exe' -OutFile .\idf-env.exe; .\idf-env.exe driver install --espressif + +On Linux adding OpenOCD udev rules is required and is done by placing the following `udev rules file `_ in the ``/etc/udev/rules.d`` folder. diff --git a/docs/en/api-guides/jtag-debugging/configure-ft2232h-jtag.rst b/docs/en/api-guides/jtag-debugging/configure-ft2232h-jtag.rst index 26df10fde6..74e7a43faf 100644 --- a/docs/en/api-guides/jtag-debugging/configure-ft2232h-jtag.rst +++ b/docs/en/api-guides/jtag-debugging/configure-ft2232h-jtag.rst @@ -74,7 +74,7 @@ Linux crw-rw---- 1 root dialout 188, 1 Jul 10 19:04 /dev/ttyUSB1 -3. Following section "Permissions delegation" in `OpenOCD's README `_, set up the access permissions to both USB ports. +3. To set up access permissions to OpenOCD supported USB devices, place the following `udev rules file `_ in the ``/etc/udev/rules.d`` folder. 4. Log off and login, then cycle the power to the board to make the changes effective. In terminal enter again ``ls -l /dev/ttyUSB*`` command to verify, if group-owner has changed from ``dialout`` to ``plugdev``: diff --git a/docs/en/api-guides/jtag-debugging/configure-other-jtag.rst b/docs/en/api-guides/jtag-debugging/configure-other-jtag.rst index b4beab8123..0d68553ce4 100644 --- a/docs/en/api-guides/jtag-debugging/configure-other-jtag.rst +++ b/docs/en/api-guides/jtag-debugging/configure-other-jtag.rst @@ -44,6 +44,7 @@ Configure Drivers You may need to install driver software to make JTAG work with computer. Refer to documentation of your JTAG adapter for related details. +On Linux adding OpenOCD udev rules is required and is done by placing the following `udev rules file `_ in the ``/etc/udev/rules.d`` folder. Connect ^^^^^^^ From 6c8d4ed6ecc04a4c01258868c024fe7d68aaf9f7 Mon Sep 17 00:00:00 2001 From: Wang Zi Yan Date: Mon, 13 Mar 2023 11:35:28 +0800 Subject: [PATCH 2/2] docs: update translation for configure-ft2232h-jtag.rst and configure-other-jtag.rst --- docs/en/api-guides/jtag-debugging/configure-ft2232h-jtag.rst | 2 +- docs/en/api-guides/jtag-debugging/configure-other-jtag.rst | 2 +- docs/zh_CN/api-guides/jtag-debugging/configure-ft2232h-jtag.rst | 2 +- docs/zh_CN/api-guides/jtag-debugging/configure-other-jtag.rst | 1 + 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/en/api-guides/jtag-debugging/configure-ft2232h-jtag.rst b/docs/en/api-guides/jtag-debugging/configure-ft2232h-jtag.rst index 74e7a43faf..99720af1c1 100644 --- a/docs/en/api-guides/jtag-debugging/configure-ft2232h-jtag.rst +++ b/docs/en/api-guides/jtag-debugging/configure-ft2232h-jtag.rst @@ -74,7 +74,7 @@ Linux crw-rw---- 1 root dialout 188, 1 Jul 10 19:04 /dev/ttyUSB1 -3. To set up access permissions to OpenOCD supported USB devices, place the following `udev rules file `_ in the ``/etc/udev/rules.d`` folder. +3. To set up access permissions to USB devices supported by OpenOCD, copy the `udev rules file `_ into the ``/etc/udev/rules.d`` directory. 4. Log off and login, then cycle the power to the board to make the changes effective. In terminal enter again ``ls -l /dev/ttyUSB*`` command to verify, if group-owner has changed from ``dialout`` to ``plugdev``: diff --git a/docs/en/api-guides/jtag-debugging/configure-other-jtag.rst b/docs/en/api-guides/jtag-debugging/configure-other-jtag.rst index 0d68553ce4..ddab498d63 100644 --- a/docs/en/api-guides/jtag-debugging/configure-other-jtag.rst +++ b/docs/en/api-guides/jtag-debugging/configure-other-jtag.rst @@ -44,7 +44,7 @@ Configure Drivers You may need to install driver software to make JTAG work with computer. Refer to documentation of your JTAG adapter for related details. -On Linux adding OpenOCD udev rules is required and is done by placing the following `udev rules file `_ in the ``/etc/udev/rules.d`` folder. +On Linux, adding OpenOCD udev rules is required and is done by copying the `udev rules file `_ into the ``/etc/udev/rules.d`` directory. Connect ^^^^^^^ diff --git a/docs/zh_CN/api-guides/jtag-debugging/configure-ft2232h-jtag.rst b/docs/zh_CN/api-guides/jtag-debugging/configure-ft2232h-jtag.rst index 312156e1fc..1a782dbaea 100644 --- a/docs/zh_CN/api-guides/jtag-debugging/configure-ft2232h-jtag.rst +++ b/docs/zh_CN/api-guides/jtag-debugging/configure-ft2232h-jtag.rst @@ -74,7 +74,7 @@ Linux crw-rw---- 1 root dialout 188, 1 Jul 10 19:04 /dev/ttyUSB1 -3. 根据 `OpenOCD README 文档 `_ 中 “Permissions delegation” 小节的介绍，设置这两个 USB 端口的访问权限。 +3. 设置 OpenOCD 所支持 USB 设备的访问权限，请将 `udev 规则文件 `_ 复制到 ``/etc/udev/rules.d`` 目录中。 4. 注销并重新登录 Linux 系统，然后重新插拔板子的电源使之前的改动生效。在终端再次输入 ``ls -l /dev/ttyUSB*`` 命令进行验证，查看这两个设备的组所有者是否已经从 ``dialout`` 更改为 ``plugdev``: diff --git a/docs/zh_CN/api-guides/jtag-debugging/configure-other-jtag.rst b/docs/zh_CN/api-guides/jtag-debugging/configure-other-jtag.rst index 651fe656fa..69244ac2ed 100644 --- a/docs/zh_CN/api-guides/jtag-debugging/configure-other-jtag.rst +++ b/docs/zh_CN/api-guides/jtag-debugging/configure-other-jtag.rst @@ -44,6 +44,7 @@ 您可能还需要安装软件驱动，才能使 JTAG 在计算机上正常工作，请参阅您所使用的 JTAG 适配器的有关文档，获取相关详细信息。 +在 Linux 中，请务必将 `udev 规则文件 `_ 复制到 ``/etc/udev/rules.d`` 目录中，以添加 OpenOCD udev 规则。 连接 ^^^^