Merge branch 'bugfix/build_openocd_from_sources' into 'master'

docs: Provide instructions on how to resolve issue with 'raggedright' when building openocd from sources

See merge request espressif/esp-idf!20214
This commit is contained in:
Krzysztof Budzynski 2022-09-23 12:32:54 +08:00
commit 0cc6fef626
2 changed files with 10 additions and 0 deletions

View File

@ -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``.

View File

@ -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`` 启用它。