From: Eli Zaretskii <eliz@gnu.org>
To: Pedro Alves <palves@redhat.com>
Cc: gdb-patches@sourceware.org, philippe.waroquiers@skynet.be
Subject: Re: [PATCH v2 4/4] Introduce the "with" command
Date: Wed, 19 Jun 2019 16:53:00 -0000 [thread overview]
Message-ID: <83lfxxqzy5.fsf@gnu.org> (raw)
In-Reply-To: <3e69e8c9-9025-90ec-e6f6-73e04bd22360@redhat.com> (message from Pedro Alves on Wed, 19 Jun 2019 16:46:23 +0100)
> Cc: gdb-patches@sourceware.org, philippe.waroquiers@skynet.be
> From: Pedro Alves <palves@redhat.com>
> Date: Wed, 19 Jun 2019 16:46:23 +0100
>
> >> +@cindex change default behavior of commands
> >> +@cindex change default settings
> >
> > Two index entries that start with the same text and point to the same
> > place are not useful. I'd drop the second one.
>
> I thought it was useful because someone skimming the
> index might not relate "behavior of commands" to "settings"
> and vice versa. (settings affect more than commands, like
> e.g., they change how gdb reacts to inferior events, like forking.)
> But looking at the resulting page, I have to agree with you,
> at least the the repetition seems odd.
>
> Some settings use a comma to add some kind of context.
> So how about doing something similar here, like:
>
> @cindex change default behavior of commands, settings
>
> ?
I'd suggest to reorder the words of your original second entry:
@cindex default settings, changing
Then we can have both of these entries.
> +If a @var{command} is provided, it must be preceded by a double dash
> +(@code{--}) separator. This is required because some settings accept
> +free-form arguments, such as expressions or filenames.
>
> As I had mentioned before, it may be we can make this delimiter
> optional. Also, we may need a "with -separate SEP" option in
> case someone wants to use an expression with "--" in it. However,
> I'd rather leave it to a separate pass, as I don't want to spend
> much more time on this at this point and the need for that should
> be quite rare.
OK. We can revisit the text when we get to that second pass.
> SETTING is any GDB setting changeable with the "set" command.
>
> Do you have a better suggestion?
Instead of "changeable", I'd use "you can change". Otherwise, SGTM.
> + @var{value} is the value the setting is changed to while
> +the command is run.
Let's try to avoid passive tense, okay?
@var{value} is the value to assign to @var{setting} while running
@var{command}.
WDYT?
Thanks.
next prev parent reply other threads:[~2019-06-19 16:53 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-18 0:39 [PATCH v2 0/4] " Pedro Alves
2019-06-18 0:39 ` [PATCH v2 2/4] Fix a few comments in maint-test-settings.c Pedro Alves
2019-06-18 0:39 ` [PATCH v2 3/4] "maint test-settings set/show" -> "maint set/show test-settings" Pedro Alves
2019-06-18 16:35 ` Eli Zaretskii
2019-06-18 0:39 ` [PATCH v2 1/4] Fix defaults of some "maint test-settings" subcommands Pedro Alves
2019-06-18 0:39 ` [PATCH v2 4/4] Introduce the "with" command Pedro Alves
2019-06-18 16:42 ` Eli Zaretskii
2019-06-19 15:46 ` Pedro Alves
2019-06-19 16:53 ` Eli Zaretskii [this message]
2019-06-19 17:20 ` [PATCH v2.1] " Pedro Alves
2019-06-22 10:30 ` Philippe Waroquiers
2019-06-22 11:48 ` Pedro Alves
2019-06-22 12:09 ` Philippe Waroquiers
2019-06-19 0:34 ` [PATCH v2 0/4] " Philippe Waroquiers
2019-06-19 13:05 ` Pedro Alves
2019-06-19 13:40 ` Philippe Waroquiers
2019-07-03 12:49 ` Pedro Alves
2019-08-02 23:24 ` New FAIL on gdb.base/with.exp on native-extended-gdbserver (was: Re: [PATCH v2 0/4] Introduce the "with" command) Sergio Durigan Junior
2020-05-11 14:54 ` [PATCH] gdb/testsuite: fix gdb.base/with.exp failure with, native-extended-gdbserver (was: New FAIL on gdb.base/with.exp on native-extended-gdbserver) Simon Marchi
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=83lfxxqzy5.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=gdb-patches@sourceware.org \
--cc=palves@redhat.com \
--cc=philippe.waroquiers@skynet.be \
/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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).