From: Pedro Alves <pedro@palves.net>
To: Eli Zaretskii <eliz@gnu.org>
Cc: gdb-patches@sourceware.org
Subject: Re: [PATCH] Improve clear command's documentation
Date: Tue, 31 May 2022 14:04:00 +0100 [thread overview]
Message-ID: <3c77c9b4-9984-0a71-c6fc-04fc707b6b07@palves.net> (raw)
In-Reply-To: <83k0a1j2ur.fsf@gnu.org>
On 2022-05-31 13:36, Eli Zaretskii wrote:
>> Date: Tue, 31 May 2022 12:05:53 +0100
>> Cc: gdb-patches@sourceware.org
>> From: Pedro Alves <pedro@palves.net>
>>
>> How about this, basically a complete rewrite of the clear command's
>> documentation:
>
> Thanks, the idea to rewrite it is indeed a good one. But the actual
> text IMO came out highly repetitive, and has several markup issues.
> Rather than commenting on each issue, I suggest the following reworded
> text:
>
> @item clear @var{locspec}
> Delete any breakpoint whose code location corresponds to
> @var{locspec}. @xref{Location Specifications}, for the various forms
> of @var{locspec}. Which code locations correspond to @var{locspec}
> depends on the form used in the location specifications @var{locspec}:
>
> @table @code
> @item @var{linenum}
> @itemx @var{filename}:@var{linenum}
> @itemx -line @var{linenum}
> @itemx -source @var{filename} -line @var{linenum}
> If @var{locspec} specifies a line number, with or without a file
> name, the command deletes any breakpoint whose code location is
> at or within the specified line @var{linenum} in files that match the
> specified @var{filename}. If @var{filename} is omitted, it defaults
> to the current source file.
>
> @item *@var{address}
> If @var{locspec} specifies an address, the command deletes any
> breakpoint whose code location is at the given @var{address}.
>
> @item @var{function}
> @itemx -function @var{function}
> If @var{locspec} specifies a function, the command deletes any
> breakpoint whose code location is at the entry to any function whose
> name matches @var{function}.
> @end table
>
> Ambiguity in names of files and functions can be resolved as
> described in @ref{Location Specifications}.
>
> WDYT?
>
I like this a lot. Will you merge it, or shall I?
next prev parent reply other threads:[~2022-05-31 13:04 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-26 19:42 [PATCH v4] gdb/manual: Introduce location specs Pedro Alves
2022-05-27 14:16 ` Eli Zaretskii via Gdb-patches
2022-05-27 15:04 ` Pedro Alves
2022-05-27 15:52 ` Eli Zaretskii via Gdb-patches
2022-05-27 17:11 ` Pedro Alves
2022-05-27 17:31 ` Eli Zaretskii via Gdb-patches
2022-05-27 17:51 ` Pedro Alves
2022-05-27 18:23 ` Eli Zaretskii via Gdb-patches
2022-05-27 18:42 ` Pedro Alves
2022-05-27 18:50 ` Pedro Alves
2022-05-27 19:00 ` Eli Zaretskii via Gdb-patches
2022-05-27 19:30 ` Pedro Alves
2022-05-28 7:43 ` Eli Zaretskii via Gdb-patches
2022-05-30 14:38 ` Pedro Alves
2022-05-27 18:55 ` Eli Zaretskii via Gdb-patches
2022-05-27 19:05 ` Pedro Alves
2022-05-27 19:14 ` Eli Zaretskii via Gdb-patches
2022-05-27 19:17 ` Pedro Alves
2022-05-27 19:34 ` Eli Zaretskii via Gdb-patches
2022-05-27 19:38 ` Pedro Alves
2022-05-28 7:39 ` Eli Zaretskii via Gdb-patches
2022-05-30 14:44 ` [pushed v5] " Pedro Alves
2022-05-30 16:15 ` Eli Zaretskii via Gdb-patches
2022-05-31 11:05 ` [PATCH] Improve clear command's documentation Pedro Alves
2022-05-31 12:36 ` Eli Zaretskii via Gdb-patches
2022-05-31 13:04 ` Pedro Alves [this message]
2022-05-31 13:42 ` Eli Zaretskii via Gdb-patches
2022-05-31 14:47 ` Pedro Alves
2022-05-31 16:06 ` Eli Zaretskii via Gdb-patches
2022-05-31 11:13 ` [PATCH] Explicitly mention yet-unloaded shared libraries in location spec examples Pedro Alves
2022-05-31 11:47 ` Eli Zaretskii via Gdb-patches
2022-05-31 11:17 ` [pushed v5] gdb/manual: Introduce location specs Pedro Alves
2022-05-31 11:31 ` [PATCH] Improve break-range's documentation Pedro Alves
2022-05-31 11:55 ` Eli Zaretskii via Gdb-patches
2022-05-31 12:03 ` Pedro Alves
2022-05-31 12:09 ` Eli Zaretskii via Gdb-patches
2022-06-01 17:17 ` RTe: Location Specs (Was: [pushed v5] gdb/manual: Introduce location specs) Eli Zaretskii via Gdb-patches
2022-06-02 11:10 ` Pedro Alves
2022-06-02 11:49 ` Eli Zaretskii via Gdb-patches
2022-06-02 12:40 ` Pedro Alves
2022-06-02 12:56 ` Eli Zaretskii via Gdb-patches
2022-06-02 13:44 ` Pedro Alves
2022-06-02 16:37 ` Eli Zaretskii via Gdb-patches
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=3c77c9b4-9984-0a71-c6fc-04fc707b6b07@palves.net \
--to=pedro@palves.net \
--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