From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id 773043858D33 for ; Thu, 16 Feb 2023 09:28:35 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 773043858D33 Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=redhat.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1676539715; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=A2D4l3QWWKXvAeWwB2+Xf8+0axNqZT73EgkKDvhUJXA=; b=KUWFjXBWceq8SDwLpQpXOEZBqSzTbFdCZ2a20575Rtbioxu/SU9GbqqWEgm052/WAKdXwL Hu+e7AvXCEPCDEz1UsciAVlIOvdBykreHE499tMPQ5AZWQmccjRwNLwqgxg8qALZiuPGCG 8uRHjAyjHhvVwTHlN+leiVqExY1pLKo= Received: from mail-qk1-f199.google.com (mail-qk1-f199.google.com [209.85.222.199]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_128_GCM_SHA256) id us-mta-458-V5jcYq7POa-N3bshSpzzHQ-1; Thu, 16 Feb 2023 04:28:34 -0500 X-MC-Unique: V5jcYq7POa-N3bshSpzzHQ-1 Received: by mail-qk1-f199.google.com with SMTP id x7-20020a05620a098700b007242aa494ddso823622qkx.19 for ; Thu, 16 Feb 2023 01:28:33 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; 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=A2D4l3QWWKXvAeWwB2+Xf8+0axNqZT73EgkKDvhUJXA=; b=AucEtwPznGJg0+YGPNczuCppO6EbgPK2PKcOUgXbXEfGygLQSEED8UOG25H2/ZaRsn 2gFx/pUM+UdfoKWqJeNUq9+5ywMFFsw+/kcbDYmNPLJUSxO5tBtXYehOY5VbapyLQOvr E9YoTO9kVVffFWP60pw9JKGRDwwbo+TVzqgiiafXYQalkEGv87CbefqOZPg52JwxvT7w Ts6vUPQlIA6HS6JXkggwssD6uDqkpXVQRkJetsPt5NHk1dOwj2m0Rlinwa6+3IGLS1xQ X2fcY3h3pKFluje2NUHgzERihWiqlOc/l0FzkEOYi5h4aRGFL0MfMWeZ3A96ip+mfgV0 nzog== X-Gm-Message-State: AO0yUKVaBFey63ba4SzdjEjaX9iIZrOCNzPIAYTKAhiF6VU9/APkSXYm HozZMI5OVmYkmSUwpg/SRAcCk1MJ9HfKfm0O5/OY15p9obWGSbu5EAw87r2RJUumHboBPX6G5If Yx2txmyuzmSrbBOezokCbdU7k4hxLUZXT6JN52G72qomdyrm+hSzKn59FYaSx5YY+tEQaX8HqVD gtYic= X-Received: by 2002:a05:6214:268c:b0:56f:37a:4563 with SMTP id gm12-20020a056214268c00b0056f037a4563mr292575qvb.42.1676539713456; Thu, 16 Feb 2023 01:28:33 -0800 (PST) X-Google-Smtp-Source: AK7set+v2c33G8hYA5DLjYUmMAQBrf3GC7v/LJ/TwBEQ/mamnfj1kZLrYzx8LLwJrs1+1TNPN19Qzg== X-Received: by 2002:a05:6214:268c:b0:56f:37a:4563 with SMTP id gm12-20020a056214268c00b0056f037a4563mr292546qvb.42.1676539713069; Thu, 16 Feb 2023 01:28:33 -0800 (PST) Received: from localhost (95.72.115.87.dyn.plus.net. [87.115.72.95]) by smtp.gmail.com with ESMTPSA id a186-20020a3798c3000000b0073b878e3f30sm841778qke.59.2023.02.16.01.28.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 16 Feb 2023 01:28:32 -0800 (PST) From: Andrew Burgess To: gdb-patches@sourceware.org Cc: Andrew Burgess Subject: [PATCH] gdb/doc: Consistency fixes for GDB/MI documentation Date: Thu, 16 Feb 2023 09:28:29 +0000 Message-Id: <472d480eb7923c863e97564a6d70e1bd8dfb6ef5.1676539697.git.aburgess@redhat.com> X-Mailer: git-send-email 2.25.4 MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII"; x-default=true X-Spam-Status: No, score=-11.6 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,GIT_PATCH_0,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_NONE,TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org List-Id: I noticed two inconsistencies in the GDB/MI documentation, which this commit addresses: 1. Each MI command is introduced like this: @subheading The @code{-command-name} Command Except for a few of the tracing command, which just use: @subheading -command-name In this commit I've updated all these trace commands to use the more common format. 2. Each MI command starts with a @subheading, and then the details of that command are split up using multiple @subsubheading entries. Except for a few commands which use @subheading for the top-level command, and then continue to use @subheading for each part of the command description. In this commit I've updated these to use @subsubheading where appropriate. --- gdb/doc/gdb.texinfo | 54 ++++++++++++++++++++++----------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index 8c2cd23df18..eb76f2bc9e8 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -35930,7 +35930,7 @@ The corresponding @value{GDBN} command is @samp{tfind}. @findex -trace-define-variable -@subheading -trace-define-variable +@subheading The @code{-trace-define-variable} Command @subsubheading Synopsis @@ -36065,7 +36065,7 @@ @subsubheading Example @findex -trace-list-variables -@subheading -trace-list-variables +@subheading The @code{-trace-list-variables} Command @subsubheading Synopsis @@ -36111,7 +36111,7 @@ @end smallexample @findex -trace-save -@subheading -trace-save +@subheading The @code{-trace-save} Command @subsubheading Synopsis @@ -36134,7 +36134,7 @@ @findex -trace-start -@subheading -trace-start +@subheading The @code{-trace-start} Command @subsubheading Synopsis @@ -36150,7 +36150,7 @@ The corresponding @value{GDBN} command is @samp{tstart}. @findex -trace-status -@subheading -trace-status +@subheading The @code{-trace-status} Command @subsubheading Synopsis @@ -36225,7 +36225,7 @@ The corresponding @value{GDBN} command is @samp{tstatus}. @findex -trace-stop -@subheading -trace-stop +@subheading The @code{-trace-stop} Command @subsubheading Synopsis @@ -38114,7 +38114,7 @@ @findex -list-thread-groups @subheading The @code{-list-thread-groups} Command -@subheading Synopsis +@subsubheading Synopsis @smallexample -list-thread-groups [ --available ] [ --recurse 1 ] [ @var{group} ... ] @@ -38208,7 +38208,7 @@ @end table -@subheading Example +@subsubheading Example @smallexample (@value{GDBP}) @@ -38310,7 +38310,7 @@ @findex -add-inferior @subheading The @code{-add-inferior} Command -@subheading Synopsis +@subsubheading Synopsis @smallexample -add-inferior [ --no-connection ] @@ -38348,12 +38348,12 @@ The name of the connection type used for the new inferior. @end table -@subheading @value{GDBN} Command +@subsubheading @value{GDBN} Command The corresponding @value{GDBN} command is @samp{add-inferior} (@pxref{add_inferior_cli,,@samp{add-inferior}}). -@subheading Example +@subsubheading Example @smallexample (@value{GDBP}) @@ -38397,7 +38397,7 @@ @findex -interpreter-exec @subheading The @code{-interpreter-exec} Command -@subheading Synopsis +@subsubheading Synopsis @smallexample -interpreter-exec @var{interpreter} @var{command} @@ -38406,11 +38406,11 @@ Execute the specified @var{command} in the given @var{interpreter}. -@subheading @value{GDBN} Command +@subsubheading @value{GDBN} Command The corresponding @value{GDBN} command is @samp{interpreter-exec}. -@subheading Example +@subsubheading Example @smallexample (gdb) @@ -38425,7 +38425,7 @@ @findex -inferior-tty-set @subheading The @code{-inferior-tty-set} Command -@subheading Synopsis +@subsubheading Synopsis @smallexample -inferior-tty-set /dev/pts/1 @@ -38433,11 +38433,11 @@ Set terminal for future runs of the program being debugged. -@subheading @value{GDBN} Command +@subsubheading @value{GDBN} Command The corresponding @value{GDBN} command is @samp{set inferior-tty} /dev/pts/1. -@subheading Example +@subsubheading Example @smallexample (gdb) @@ -38449,7 +38449,7 @@ @findex -inferior-tty-show @subheading The @code{-inferior-tty-show} Command -@subheading Synopsis +@subsubheading Synopsis @smallexample -inferior-tty-show @@ -38457,11 +38457,11 @@ Show terminal for future runs of program being debugged. -@subheading @value{GDBN} Command +@subsubheading @value{GDBN} Command The corresponding @value{GDBN} command is @samp{show inferior-tty}. -@subheading Example +@subsubheading Example @smallexample (gdb) @@ -38476,7 +38476,7 @@ @findex -enable-timings @subheading The @code{-enable-timings} Command -@subheading Synopsis +@subsubheading Synopsis @smallexample -enable-timings [yes | no] @@ -38487,11 +38487,11 @@ developers optimize the performance of their code. No argument is equivalent to @samp{yes}. -@subheading @value{GDBN} Command +@subsubheading @value{GDBN} Command No equivalent. -@subheading Example +@subsubheading Example @smallexample (gdb) @@ -38521,7 +38521,7 @@ @findex -complete @subheading The @code{-complete} Command -@subheading Synopsis +@subsubheading Synopsis @smallexample -complete @var{command} @@ -38533,7 +38533,7 @@ CLI and MI channels --- for example: because of lack of PTYs like on Windows or because @value{GDBN} is used remotely via a SSH connection. -@subheading Result +@subsubheading Result The result consists of two or three fields: @@ -38552,11 +38552,11 @@ @end table -@subheading @value{GDBN} Command +@subsubheading @value{GDBN} Command The corresponding @value{GDBN} command is @samp{complete}. -@subheading Example +@subsubheading Example @smallexample (gdb) base-commit: 42af03dafee14cf7b3f4e324ceca1b0ababd1eb9 -- 2.25.4