From: Eli Zaretskii <eliz@gnu.org>
To: Andrew Burgess <aburgess@redhat.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [PATCH 3/5] gdb/doc: consistent formatting for on|off on @item lines
Date: Tue, 13 Oct 2026 14:33:49 +0300 [thread overview]
Message-ID: <8633u9hm1u.fsf@gnu.org> (raw)
In-Reply-To: <e70dead02a3351043f1776ee140e62c0b05b6c86.1791831032.git.aburgess@redhat.com> (message from Andrew Burgess on Mon, 12 Oct 2026 19:54:28 +0100)
> From: Andrew Burgess <aburgess@redhat.com>
> Cc: Andrew Burgess <aburgess@redhat.com>
> Date: Mon, 12 Oct 2026 19:54:28 +0100
>
> When a command takes 'on' or 'off' as an option then we have a bunch
> of styles for how this is presented within a table's @item line:
>
> @item set logging enabled [on|off]
> @item -past-main [@code{on}|@code{off}]
> @item set auto-load python-scripts @r{[}on@r{|}off@r{]}
>
> Of these the last seems to be the style that is most often used for
> new additions. I think it's the correct one because:
>
> 1. Use @r{...} to wrap the characters that are not part of the
> command: [|], this ensures these characters are formatted as
> normal text, not using the table style, which should be @kbd.
>
> 2. Wrapping 'on' and 'off' in @code{...} is clearly wrong, there
> are not code. Using @samp{...} might work, but this isn't what
> we currently do, and the 'on' and 'off' could be considered just
> another part of the command, so using the table's default @kbd
> style seems reasonable enough.
>
> This commit updates some cases in the documentation which used the
> first two styles to use the third style, this makes things more
> consistent.
> ---
> gdb/doc/gdb.texinfo | 78 ++++++++++++++++++++++-----------------------
> gdb/doc/guile.texi | 4 +--
> gdb/doc/python.texi | 4 +--
> 3 files changed, 43 insertions(+), 43 deletions(-)
Thanks, this is okay.
Approved-By: Eli Zaretskii <eliz@gnu.org>
next prev parent reply other threads:[~2026-10-13 11:34 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-10-12 18:54 [PATCH 0/5] gdb/doc: a series of doc clean ups Andrew Burgess
2026-10-12 18:54 ` [PATCH 1/5] gdb/doc: use (@value{GDBP}) for the prompt in examples Andrew Burgess
2026-10-13 11:43 ` Eli Zaretskii
2026-10-12 18:54 ` [PATCH 2/5] gdb/doc: fix some incorrect '@table @code' uses Andrew Burgess
2026-10-13 11:56 ` Eli Zaretskii
2026-10-12 18:54 ` [PATCH 3/5] gdb/doc: consistent formatting for on|off on @item lines Andrew Burgess
2026-10-13 11:33 ` Eli Zaretskii [this message]
2026-10-12 18:54 ` [PATCH 4/5] gdb/doc: make more use of @option{...} formatting Andrew Burgess
2026-10-13 12:00 ` Eli Zaretskii
2026-10-12 18:54 ` [PATCH 5/5] gdb/doc: more @command and @kbd Andrew Burgess
2026-10-13 11:43 ` Eli Zaretskii
2026-10-16 14:52 ` 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=8633u9hm1u.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