From: Andrew Burgess <aburgess@redhat.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: gdb-patches@sourceware.org
Subject: Re: [PATCH 5/5] gdb/doc: more @command and @kbd
Date: Fri, 16 Oct 2026 15:52:01 +0100 [thread overview]
Message-ID: <87o6ct8zqm.fsf@redhat.com> (raw)
In-Reply-To: <861p9thlmf.fsf@gnu.org>
Eli Zaretskii <eliz@gnu.org> writes:
>> From: Andrew Burgess <aburgess@redhat.com>
>> Cc: Andrew Burgess <aburgess@redhat.com>
>> Date: Mon, 12 Oct 2026 19:54:30 +0100
>>
>> I spotted some places in the docs where we used @code{...} to wrap a
>> command name when we should be using @command{...}. This commit
>> started off with me just trying to fix these.
>>
>> Some cases can get a little confusing though. Consider the
>> documentation that discusses the GDB 'make' command. In talking about
>> what this GDB command does the documentation references the external
>> program 'make', which needs wrapping in @command{}, but there are also
>> mentions of the GDB command itself, which needs wrapping with @kbd{}.
>>
>> As these all seemed related I've tried to clean up as many of these as
>> I could find. As such, this commit is mostly changing things like
>> @code and @samp to @command and @kbd as needed.
>> ---
>> gdb/doc/gdb.texinfo | 128 ++++++++++++++++++++++----------------------
>> 1 file changed, 64 insertions(+), 64 deletions(-)
>
> Thanks, this is okay, with a couple of nits below fixed.
>
>> @item GNU make
>> @value{GDBN}'s build system relies on features only found in the GNU
>> -make program. Other variants of @code{make} will not work.
>> +make program. Other variants of @command{make} will not work.
> ^^^^
> This should also be in @command.
>
>> -To build @code{gdb} in a separate directory, run @file{configure}
>> +To build @code{gdb} in a separate directory, run @command{configure}
> ^^^^^^^^^^
> This should use @value{GDBN}.
>
> Approved-By: Eli Zaretskii <eliz@gnu.org>
Eli,
I addressed the nits you pointed out and pushed this series.
Thanks,
Andrew
prev parent reply other threads:[~2026-10-16 14:54 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
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 [this message]
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=87o6ct8zqm.fsf@redhat.com \
--to=aburgess@redhat.com \
--cc=eliz@gnu.org \
--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