From: Eli Zaretskii <eliz@gnu.org>
To: Andrew Burgess <aburgess@redhat.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [PATCH] gdb/doc: Consistency fixes for GDB/MI documentation
Date: Thu, 16 Feb 2023 13:43:25 +0200 [thread overview]
Message-ID: <835yc196oy.fsf@gnu.org> (raw)
In-Reply-To: <472d480eb7923c863e97564a6d70e1bd8dfb6ef5.1676539697.git.aburgess@redhat.com> (message from Andrew Burgess via Gdb-patches on Thu, 16 Feb 2023 09:28:29 +0000)
> Cc: Andrew Burgess <aburgess@redhat.com>
> Date: Thu, 16 Feb 2023 09:28:29 +0000
> From: Andrew Burgess via Gdb-patches <gdb-patches@sourceware.org>
>
> 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(-)
Thanks, this belongs to the "obvious fix" department, so please
install.
Approved-By: Eli Zaretskii <eliz@gnu.org>
next prev parent reply other threads:[~2023-02-16 11:43 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-16 9:28 Andrew Burgess
2023-02-16 11:43 ` Eli Zaretskii [this message]
2023-02-20 14:28 ` Andrew Burgess
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=835yc196oy.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=aburgess@redhat.com \
--cc=gdb-patches@sourceware.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).