Răsfoiți Sursa

Merge branch 'docs/add_link_to_vscode_debug_configuration' into 'master'

docs: add link to configuration of VSCode debug

See merge request espressif/esp-idf!22526
Zhang Xiao Yan 3 ani în urmă
părinte
comite
268a662e6c

+ 2 - 1
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 <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/DEBUGGING.md>`__
 
 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`.
 

+ 3 - 1
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 <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/DEBUGGING.md>`__ 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

+ 3 - 2
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 调试 <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/DEBUGGING.md>`__
 
 建议首先检查调试器能否在 :ref:`命令行终端 <jtag-debugging-using-debugger-command-line>` 下正常工作,然后再使用 Eclipse :ref:`集成开发环境 <jtag-debugging-using-debugger-eclipse>` 进行调试工作。
 

+ 2 - 0
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 调试 <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/DEBUGGING.md>`__。
+
 
 .. _jtag-debugging-using-debugger-eclipse: