From 707d49e161b8e51ac1e4e0ebdd588e0221114770 Mon Sep 17 00:00:00 2001 From: Krzysztof Date: Mon, 19 Sep 2022 13:13:59 +0800 Subject: [PATCH 1/2] docs: Provide instructions on how to resolve issue with 'raggedright' when building openocd from sources --- docs/en/api-guides/jtag-debugging/building-openocd-macos.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/en/api-guides/jtag-debugging/building-openocd-macos.rst b/docs/en/api-guides/jtag-debugging/building-openocd-macos.rst index 52b6c985c5b..9b7b724d11e 100644 --- a/docs/en/api-guides/jtag-debugging/building-openocd-macos.rst +++ b/docs/en/api-guides/jtag-debugging/building-openocd-macos.rst @@ -41,6 +41,11 @@ Optionally you can add ``sudo make install`` step at the end. Skip it, if you ha .. note:: * Should an error occur, resolve it and try again until the command ``make`` works. + * Error ``Unknown command 'raggedright'`` may indicate that the required version of ``texinfo`` was not installed on your computer or installed but was not linked to your PATH. To resolve this issue make sure ``texinfo`` is installed and PATH is adjusted prior to the ``./bootstrap`` by running:: + + brew install texinfo + export PATH=/usr/local/opt/texinfo/bin:$PATH + * If there is a submodule problem from OpenOCD, please ``cd`` to the ``openocd-esp32`` directory and input ``git submodule update --init``. * If the ``./configure`` is successfully run, information of enabled JTAG will be printed under ``OpenOCD configuration summary``. * If the information of your device is not shown in the log, use ``./configure`` to enable it as described in ``../openocd-esp32/doc/INSTALL.txt``. From e03a33733710923ad308104c1537e90abbb9c15d Mon Sep 17 00:00:00 2001 From: daiziyan Date: Wed, 21 Sep 2022 14:46:55 +0800 Subject: [PATCH 2/2] docs: updated CN trans for building-openocd-macos --- .../api-guides/jtag-debugging/building-openocd-macos.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/zh_CN/api-guides/jtag-debugging/building-openocd-macos.rst b/docs/zh_CN/api-guides/jtag-debugging/building-openocd-macos.rst index e6060607f5f..96f0868be1c 100644 --- a/docs/zh_CN/api-guides/jtag-debugging/building-openocd-macos.rst +++ b/docs/zh_CN/api-guides/jtag-debugging/building-openocd-macos.rst @@ -41,6 +41,11 @@ MacOS 环境下从源码编译 OpenOCD .. note:: * 如果发生错误，请解决后再次尝试编译，直到 ``make`` 成功为止。 + * 发生 ``Unknown command 'raggedright'`` 错误可能是因为安装的 ``texinfo`` 版本不对，或是由于没有将其添加到 PATH 路径。为了解决该问题，在运行 ``./bootstrap`` 前，请先运行如下命令确保安装合适版本的 ``texinfo`` 并将其添加到 PATH 路径:: + + brew install texinfo + export PATH=/usr/local/opt/texinfo/bin:$PATH + * 如果 OpenOCD 存在子模块问题，请 ``cd`` 到 ``openocd-esp32`` 目录，并输入 ``git submodule update --init`` 命令。 * 如果 ``./configure`` 成功运行，JTAG 被使能的信息会被打印在 ``OpenOCD configuration summary`` 下面。 * 如果您的设备信息未显示在日志中，请根据 ``../openocd-esp32/doc/INSTALL.txt`` 文中的描述使用 ``./configure`` 启用它。