Re: [PATCH v2] [gdb/debuginfod] Ask to cancel further downloads

[Eli Zaretskii <eliz@gnu.org>]

> Cc: pedro@palves.net, tdevries@suse.de, Aaron Merey <amerey@redhat.com>,
>  Martin Liška <mliska@suse.cz>
> Date: Fri, 16 Dec 2022 19:15:25 -0500
> From: Aaron Merey via Gdb-patches <gdb-patches@sourceware.org>
> 
> +  add_setshow_enum_cmd ("cancel", class_run, debuginfod_cancel_enum,
> +			_("Set cancellation mode for debuginfod."),

I suggest a more specific wording here:

  Set cancellation mode for debuginfod downloads.

> +			_("Show cancellation mode for debuginfod."),

And similarly here.

> +The cancellation mode modifies the behavior of ^C while a file is downloading\
> + from debuginfod.\nWhen set to one, two ^C cancels a single download.\n\
> +When set to all, two ^C cancels all further downloads.\n\
> +When set to ask, two ^C asks what to do.\nA single ^C during downloading is\
> + passed to the target process being debugged.\nA second ^C during downloading\
> + may raise a prompt asking whether to cancel the download or send ^C to the\
> + target.\nIf the download is to be cancelled, the cancellation mode takes\
> + effect and no ^C is sent to the target."),

This should use "cancel" and "ask", in plural, not "cancels" and
"asks" in singular, because it talks about "two ^C".

However, it might be better to say

  ..., pressing ^C twice cancels a single download

and similarly for the other instances, because "two ^C" is somewhat
awkward.  That is the wording you used for the manual, and it is
better.

> +@kindex set debuginfod cancel
> +@anchor{set debuginfod cancel}
> +@item set debuginfod cancel
> +@itemx set debuginfod cancel one
> +@cindex debuginfod cancellation mode
> +Pressing @code{^C} twice during downloading will cancel the current

I suggest to use @kbd{Ctrl-C} instead @code{^C}, here and elsewhere in
the patch.

> +@item set debuginfod cancel all
> +Pressing @code{^C} twice during downloading will cancel all further
> +downloads.

I think "this and all further downloads" is more accurate.

> +@item set debuginfod cancel ask
> +Pressing @code{^C} twice during a download will prompt the user to

Instead of "the user", please use "you", or even nothing.  The manual
is written from the POV of "the user", so we should not use "the user"
as some third party.

Also, "will prompt whether to cancel", since this is the essence of
the question.  The user is not asked to cancel, the user is asked
whether GDB should cancel.

> +cancel all further downloads before attempting to perform the next query.
                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
I'm not sure I understand the emphasized part.  What do you mean by
"before attempting"?

> +@kindex show debuginfod cancel
> +@item show debuginfod cancel
> +Display whether @code{debuginfod cancel} is set to @code{one}, @code{all} or
> +@code{ask}.

I suggest to reword this

  Display the current setting of @code{debuginfod cancel}.

Thanks.