From: Eli Zaretskii <eliz@gnu.org>
To: Andrew Burgess <aburgess@redhat.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [PATCH 4/5] gdb/doc: make more use of @option{...} formatting
Date: Tue, 13 Oct 2026 15:00:12 +0300 [thread overview]
Message-ID: <86wlrlg69f.fsf@gnu.org> (raw)
In-Reply-To: <a55d519304dd17c35424d5b29b1383c8c3492339.1791831032.git.aburgess@redhat.com> (message from Andrew Burgess on Mon, 12 Oct 2026 19:54:29 +0100)
> From: Andrew Burgess <aburgess@redhat.com>
> Cc: Andrew Burgess <aburgess@redhat.com>
> Date: Mon, 12 Oct 2026 19:54:29 +0100
>
> I noticed that there are lots of places in our docs where command line
> options, either for GDB or for other programs (e.g. compilers) are
> formatted as either @code or @samp.
Historically, @option was not originally available in Texinfo, that's
why we have so many @samp instead.
> In this commit I made use of regexp replacement looking for anything
> that matched: "@(code|samp)\{-[^}]+\}" and if I was reasonably certain
> that it was a command line option I switched to use @option{...}. If
> I had any doubt then I left things as they were.
>
> I'm sure that there are places that I've missed, but hopefully this
> makes the docs a little better.
> ---
> gdb/doc/gdb.texinfo | 350 ++++++++++++++++++++++----------------------
> gdb/doc/guile.texi | 4 +-
> 2 files changed, 177 insertions(+), 177 deletions(-)
Thanks, this is okay.
Approved-By: Eli Zaretskii <eliz@gnu.org>
next prev parent reply other threads:[~2026-10-13 12:00 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
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 [this message]
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=86wlrlg69f.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