Add link to Debugger Adapter Protocol node in documentation

Message ID 20231130192840.2702303-1-tromey@adacore.com
State New
Headers
Series Add link to Debugger Adapter Protocol node in documentation |

Checks

Context Check Description
linaro-tcwg-bot/tcwg_gdb_build--master-aarch64 success Testing passed
linaro-tcwg-bot/tcwg_gdb_build--master-arm success Testing passed
linaro-tcwg-bot/tcwg_gdb_check--master-arm success Testing passed
linaro-tcwg-bot/tcwg_gdb_check--master-aarch64 success Testing passed

Commit Message

Tom Tromey Nov. 30, 2023, 7:28 p.m. UTC
  I noticed that the interpreters node in the docs links to the DAP
protocol docs, but I thought the DAP node ought to as well.  This
patch adds a bit of introductory text there.
---
 gdb/doc/gdb.texinfo | 4 ++++
 1 file changed, 4 insertions(+)
  

Comments

Eli Zaretskii Nov. 30, 2023, 7:32 p.m. UTC | #1
> From: Tom Tromey <tromey@adacore.com>
> Cc: Tom Tromey <tromey@adacore.com>
> Date: Thu, 30 Nov 2023 12:28:40 -0700
> 
> I noticed that the interpreters node in the docs links to the DAP
> protocol docs, but I thought the DAP node ought to as well.  This
> patch adds a bit of introductory text there.

Thanks, this is okay.

Approved-By: Eli Zaretskii <eliz@gnu.org>
  

Patch

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index e4c00143fd1..15fa158a316 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -39487,6 +39487,10 @@  depend on the language).
 @node Debugger Adapter Protocol
 @chapter Debugger Adapter Protocol
 
+The Debugger Adapter Protocol is a generic API that is used by some
+IDEs to communicate with debuggers.  It is documented at
+@url{https://microsoft.github.io/debug-adapter-protocol/}.
+
 Generally, @value{GDBN} implements the Debugger Adapter Protocol as
 written.  However, in some cases, extensions are either needed or even
 expected.