From 414a5c0410ba96c85a9f988cf6fba2fa2254bdaa Mon Sep 17 00:00:00 2001 From: Linda Date: Mon, 27 Feb 2023 14:09:15 +0800 Subject: [PATCH] docs: add link to configuration of VSCode debug --- docs/en/api-guides/jtag-debugging/index.rst | 3 ++- docs/en/api-guides/jtag-debugging/using-debugger.rst | 4 +++- docs/zh_CN/api-guides/jtag-debugging/index.rst | 5 +++-- docs/zh_CN/api-guides/jtag-debugging/using-debugger.rst | 2 ++ 4 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/en/api-guides/jtag-debugging/index.rst b/docs/en/api-guides/jtag-debugging/index.rst index 12e356c790..f81b886821 100644 --- a/docs/en/api-guides/jtag-debugging/index.rst +++ b/docs/en/api-guides/jtag-debugging/index.rst @@ -228,10 +228,11 @@ Launching Debugger The toolchain for {IDF_TARGET_NAME} features GNU Debugger, in short GDB. It is available with other toolchain programs under filename: {IDF_TARGET_TOOLCHAIN_PREFIX}-gdb. GDB can be called and operated directly from command line in a terminal. Another option is to call it from within IDE (like Eclipse, Visual Studio Code, etc.) and operate indirectly with help of GUI instead of typing commands in a terminal. -Both options of using debugger are discussed under links below. +The options of using debugger are discussed under links below. * :ref:`jtag-debugging-using-debugger-eclipse` * :ref:`jtag-debugging-using-debugger-command-line` +* `Configuration for Visual Studio Code Debug `__ It is recommended to first check if debugger works from :ref:`jtag-debugging-using-debugger-command-line` and then move to using :ref:`jtag-debugging-using-debugger-eclipse`. diff --git a/docs/en/api-guides/jtag-debugging/using-debugger.rst b/docs/en/api-guides/jtag-debugging/using-debugger.rst index f6a2f22118..5109b04b56 100644 --- a/docs/en/api-guides/jtag-debugging/using-debugger.rst +++ b/docs/en/api-guides/jtag-debugging/using-debugger.rst @@ -8,6 +8,8 @@ This section covers configuration and running debugger using several methods: * from :ref:`jtag-debugging-using-debugger-command-line` * using :ref:`jtag-debugging-with-idf-py` +See also a separate document `Configuration for Visual Studio Code Debug `__ describing how to run a debugger from VS Code. + .. _jtag-debugging-using-debugger-eclipse: @@ -206,7 +208,7 @@ It is also possible to execute the described debugging tools conveniently from ` 1. ``idf.py openocd`` - Runs OpenOCD in a console with configuration defined in the environment or via command line. It uses default script directory defined as ``OPENOCD_SCRIPTS`` environmental variable, which is automatically added from an Export script (``export.sh`` or ``export.bat``). + Runs OpenOCD in a console with configuration defined in the environment or via command line. It uses default script directory defined as ``OPENOCD_SCRIPTS`` environmental variable, which is automatically added from an Export script (``export.sh`` or ``export.bat``). It is possible to override the script location using command line argument ``--openocd-scripts``. .. include:: {IDF_TARGET_PATH_NAME}.inc diff --git a/docs/zh_CN/api-guides/jtag-debugging/index.rst b/docs/zh_CN/api-guides/jtag-debugging/index.rst index 8e4081513d..7cc195c50c 100644 --- a/docs/zh_CN/api-guides/jtag-debugging/index.rst +++ b/docs/zh_CN/api-guides/jtag-debugging/index.rst @@ -226,12 +226,13 @@ OpenOCD 安装完成后就可以配置 {IDF_TARGET_NAME} 目标（即带 JTAG 启动调试器 ---------- -{IDF_TARGET_NAME} 的工具链中带有 GNU 调试器（简称 GDB），它和其它工具链软件共同存放于 {IDF_TARGET_TOOLCHAIN_PREFIX}-gdb 中。除了直接在命令行终端中调用并操作 GDB 外，也可以在 IDE (例如 Eclipse、Visual Studio Code 等）中进行调用，使用图形用户界面间接操作 GDB，这一方法无需在终端中输入任何命令。 +{IDF_TARGET_NAME} 的工具链中带有 GNU 调试器（简称 GDB），它和其它工具链软件共同存放于 {IDF_TARGET_TOOLCHAIN_PREFIX}-gdb 中。除了直接在命令行终端中调用并操作 GDB 外，也可以在 IDE（例如 Eclipse、Visual Studio Code 等）中进行调用，使用图形用户界面间接操作 GDB，这一方法无需在终端中输入任何命令。 -关于以上两种调试器的使用方法，详见以下链接。 +关于调试器的使用方法，详见以下链接。 * :ref:`jtag-debugging-using-debugger-eclipse` * :ref:`jtag-debugging-using-debugger-command-line` +* `使用 VS Code 调试 `__ 建议首先检查调试器能否在 :ref:`命令行终端 ` 下正常工作，然后再使用 Eclipse :ref:`集成开发环境 ` 进行调试工作。 diff --git a/docs/zh_CN/api-guides/jtag-debugging/using-debugger.rst b/docs/zh_CN/api-guides/jtag-debugging/using-debugger.rst index 1f8615c98d..d5e461a721 100644 --- a/docs/zh_CN/api-guides/jtag-debugging/using-debugger.rst +++ b/docs/zh_CN/api-guides/jtag-debugging/using-debugger.rst @@ -8,6 +8,8 @@ * :ref:`jtag-debugging-using-debugger-command-line` * :ref:`jtag-debugging-with-idf-py` +关于如何使用 VS Code 进行调试，请参阅文档 `使用 VS Code 调试 `__。 + .. _jtag-debugging-using-debugger-eclipse: