From patchwork Fri Apr 14 18:18:52 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tom Tromey X-Patchwork-Id: 67758 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 789D6385734F for ; Fri, 14 Apr 2023 18:19:22 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 789D6385734F DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1681496362; bh=ai0unXSnboz+vrAwjC55eAjyGStb4T2wP4LdQVR6qHw=; h=To:Cc:Subject:Date:List-Id:List-Unsubscribe:List-Archive: List-Post:List-Help:List-Subscribe:From:Reply-To:From; b=dBAZzEU+QLF+oSFtLj11Cy8S8WZK700iTet38rHSYrJyvT2m/iG+Mu4rLX40rnAma XmolYb+TZ1puvlKym/HbDaCMvavv9fJc3O0nQLKBkqY3OrcWQGTgpwoItnlgciRjtg lkswLK0fg5BWKN+DP41JBZJKMiW2cliba61OlY0A= X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from mail-io1-xd34.google.com (mail-io1-xd34.google.com [IPv6:2607:f8b0:4864:20::d34]) by sourceware.org (Postfix) with ESMTPS id 3CEF93858C54 for ; Fri, 14 Apr 2023 18:19:00 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 3CEF93858C54 Received: by mail-io1-xd34.google.com with SMTP id ca18e2360f4ac-7606d460da7so19117339f.1 for ; Fri, 14 Apr 2023 11:19:00 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1681496339; x=1684088339; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=ai0unXSnboz+vrAwjC55eAjyGStb4T2wP4LdQVR6qHw=; b=IAPUsPdL80kBM1OWcNuFY8VhIO3tBRx7Y8Twr2EDTj0IV+Qk2Aq2GCYDqsmsdhW0wB A1Kl35UX6hQ2Apgl9BM5CtIlzXjUqEkuDY9iB6nLxTTbM6cH20fjxq1B8VzFE9shzdL3 Q0qBy/xaz+yo1tXe1t7LdB5oFht2fqp3LpMICj2xHyJ8uRwysWdaiZRdmM5S10WkhUBy Snr/9riLWcP/qmcO8fX5hCns9en4qXBuAoutahvMy70q+buiqm6q2PgFdEfjHsOXdZss 0FrU+Ak8LLFrNNswsrJM8FiDtP7sS+1PCt+uvLxoruTGXmLysh6Z6b5gC4uGAACMCSRe fWXw== X-Gm-Message-State: AAQBX9dVhy9tbE/AzlUZ+x/L3DPFl7YVcfaeVRLXfMeU6k35RSsSi62w nWyhUWFJF1HzLD+frvMYbjk971BPO/7KaMPEeUDOdQ== X-Google-Smtp-Source: AKy350byqMl8ZWgul3/C6O5aDIlxE1hwK55SNO9D4w6JmnC0hXCVwumMem4uriW3FItQYT6Dgg09Fg== X-Received: by 2002:a92:cec6:0:b0:329:50cd:120b with SMTP id z6-20020a92cec6000000b0032950cd120bmr4057356ilq.11.1681496339175; Fri, 14 Apr 2023 11:18:59 -0700 (PDT) Received: from localhost.localdomain (71-211-191-82.hlrn.qwest.net. [71.211.191.82]) by smtp.gmail.com with ESMTPSA id f14-20020a92cb4e000000b003295ff72e80sm1269936ilq.84.2023.04.14.11.18.58 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 14 Apr 2023 11:18:58 -0700 (PDT) To: gdb-patches@sourceware.org Cc: Tom Tromey Subject: [PATCH] Document DAP 'launch' parameter Date: Fri, 14 Apr 2023 12:18:52 -0600 Message-Id: <20230414181852.3955774-1-tromey@adacore.com> X-Mailer: git-send-email 2.39.1 MIME-Version: 1.0 X-Spam-Status: No, score=-10.9 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Tom Tromey via Gdb-patches From: Tom Tromey Reply-To: Tom Tromey Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org Sender: "Gdb-patches" 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 --- gdb/doc/gdb.texinfo | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index 940315b2713..7d5bea5dc6f 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 @@ -29615,6 +29616,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 @@ -38969,6 +38972,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. +@end table + @node JIT Interface @chapter JIT Compilation Interface @cindex just-in-time compilation