Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Andrew Burgess <aburgess@redhat.com>
To: gdb-patches@sourceware.org
Cc: Andrew Burgess <aburgess@redhat.com>
Subject: [PATCH 0/5] gdb/doc: a series of doc clean ups
Date: Mon, 12 Oct 2026 19:54:25 +0100	[thread overview]
Message-ID: <cover.1791831032.git.aburgess@redhat.com> (raw)

This is mostly about using the correct @WORD wrapper in more places.
The GDB docs tend to overuse @code{...} and @samp{...} when there are
better choices available.

There's also a patch related to how we format on/off choices in
command help text.

There's probably a lot more stuff that can be cleaned up in the docs,
but I thought I'd see how this goes to begin with.

Thanks,
Andrew

---

Andrew Burgess (5):
  gdb/doc: use (@value{GDBP}) for the prompt in examples
  gdb/doc: fix some incorrect '@table @code' uses
  gdb/doc: consistent formatting for on|off on @item lines
  gdb/doc: make more use of @option{...} formatting
  gdb/doc: more @command and @kbd

 gdb/doc/gdb.texinfo | 1820 +++++++++++++++++++++----------------------
 gdb/doc/guile.texi  |   64 +-
 gdb/doc/python.texi |   58 +-
 3 files changed, 971 insertions(+), 971 deletions(-)


base-commit: b7ee9065ecd249773b7d582eee723686fc58dd5d
-- 
2.55.0


             reply	other threads:[~2026-10-12 18:55 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-10-12 18:54 Andrew Burgess [this message]
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
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=cover.1791831032.git.aburgess@redhat.com \
    --to=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