aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Tromey <tromey@adacore.com>2023-04-14 12:16:58 -0600
committerTom Tromey <tromey@adacore.com>2023-05-01 14:19:47 -0600
commita01e847fc8fc9bd2b16d91ff5b141afcd51ee81e (patch)
tree63fce29267550c4133d5c4f3005cb5a3976a7b38
parent970c6b7e156107e961dd7b3ac0ad33d9fccb6bff (diff)
downloadgdb-a01e847fc8fc9bd2b16d91ff5b141afcd51ee81e.zip
gdb-a01e847fc8fc9bd2b16d91ff5b141afcd51ee81e.tar.gz
gdb-a01e847fc8fc9bd2b16d91ff5b141afcd51ee81e.tar.bz2
Document DAP 'launch' parameter
The Debugger Adapter Protocol defines a "launch" request but leaves the parameters up to the implementation: Since launching is debugger/runtime specific, the arguments for this request are not part of this specification. This patch adds some documentation for the parameter GDB currently defines. Note that I plan to add more parameters here, and perhaps there will be other extensions in time as well. Reviewed-By: Eli Zaretskii <eliz@gnu.org>
-rw-r--r--gdb/doc/gdb.texinfo19
1 files changed, 19 insertions, 0 deletions
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index b21823d..ed9cec6 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -159,6 +159,7 @@ software in general. We will miss him.
* Emacs:: Using @value{GDBN} under @sc{gnu} Emacs
* GDB/MI:: @value{GDBN}'s Machine Interface.
* Annotations:: @value{GDBN}'s annotation interface.
+* Debugger Adapter Protocol:: The Debugger Adapter Protocol.
* JIT Interface:: Using the JIT debugging interface.
* In-Process Agent:: In-Process Agent
@@ -29624,6 +29625,8 @@ the Debugger Adapter Protocol. This protocol can be used by a
debugger GUI or an IDE to communicate with @value{GDBN}. This
protocol is documented at
@url{https://microsoft.github.io/debug-adapter-protocol/}.
+@xref{Debugger Adapter Protocol}, for information about @value{GDBN}
+extensions to the protocol.
@item mi
@cindex mi interpreter
@@ -38981,6 +38984,22 @@ source which is being displayed. The @var{addr} is in the form @samp{0x}
followed by one or more lowercase hex digits (note that this does not
depend on the language).
+@node Debugger Adapter Protocol
+@chapter Debugger Adapter Protocol
+
+Generally, @value{GDBN} implements the Debugger Adapter Protocol as
+written. However, in some cases, extensions are either needed or even
+expected.
+
+@value{GDBN} defines a parameter that can be passed to the
+@code{launch} request:
+
+@table @code
+@item program
+If provided, this is a string that specifies the program to use. This
+corresponds to the @code{file} command. @xref{Files}.
+@end table
+
@node JIT Interface
@chapter JIT Compilation Interface
@cindex just-in-time compilation