From: Tom Tromey <tromey@adacore.com>
Date: Wed, 3 Dec 2025 17:47:19 +0000 (-0700)
Subject: Minor reorganization to DAP launch documentation
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b824d8db3621bbb29e1bef508dd72a91b1bfbe02;p=thirdparty%2Fbinutils-gdb.git

Minor reorganization to DAP launch documentation

This changes the DAP launch/attach documentation so that common
options are called out in a separate table.

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

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 7e4abd88ac2..164565c447a 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -40200,8 +40200,22 @@ Generally, @value{GDBN} implements the Debugger Adapter Protocol as
 written.  However, in some cases, extensions are either needed or even
 expected.
 
-@value{GDBN} defines some parameters that can be passed to the
-@code{launch} request:
+In the protocol, the parameters to the @code{launch} and @code{attach}
+requests are defined by the adapter.  @value{GDBN} defines a couple
+parameters common to both:
+
+@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}.
+
+With the @code{attach} request, in some cases, @value{GDBN} can
+automatically determine which program is running.  However, for many
+remote targets, this is not the case, and so this should be supplied.
+@end table
+
+@value{GDBN} defines some additional parameters that can be passed to
+the @code{launch} request:
 
 @table @code
 @item args
@@ -40238,8 +40252,8 @@ will set a temporary breakpoint at the program's first instruction, using
 the same approach as the @code{starti} command.  @xref{Starting}.
 @end table
 
-@value{GDBN} defines some parameters that can be passed to the
-@code{attach} request.  Either @code{pid} or @code{target} must be
+@value{GDBN} defines some additional parameters that can be passed to
+the @code{attach} request.  Either @code{pid} or @code{target} must be
 specified, but if both are specified then @code{target} will be
 ignored.
 
@@ -40247,13 +40261,6 @@ ignored.
 @item pid
 The process ID to which @value{GDBN} should attach.  @xref{Attach}.
 
-@item program
-If provided, this is a string that specifies the program to use.  This
-corresponds to the @code{file} command.  @xref{Files}.  In some cases,
-@value{GDBN} can automatically determine which program is running.
-However, for many remote targets, this is not the case, and so this
-should be supplied.
-
 @item target
 The target to which @value{GDBN} should connect.  This is a string and
 is passed to the @code{target remote} command.  @xref{Connecting}.