[RFC PATCH] gdb/doc: clarify the language for the '?' packet

Eli Zaretskii eliz@gnu.org
Mon Dec 7 15:55:55 GMT 2020


> Date: Mon,  7 Dec 2020 13:53:19 +0000
> From: Alex Bennée via Gdb-patches <gdb-patches@sourceware.org>
> Cc: Alex Bennée <alex.bennee@linaro.org>
> 
> --- a/gdb/doc/gdb.texinfo
> +++ b/gdb/doc/gdb.texinfo
> @@ -39273,9 +39273,9 @@ The remote target both supports and has enabled extended mode.
>  
>  @item ?
>  @cindex @samp{?} packet
> -@anchor{? packet}
> -Indicate the reason the target halted.  The reply is the same as for
> -step and continue.  This packet has a special interpretation when the
> +@anchor{? packet} Is a query sent when connection is first established
> +to query the reason the target halted. The reply is the same as for
> +step and continue. This packet has a special interpretation when the
>  target is in non-stop mode; see @ref{Remote Non-Stop}.

Minor comments:

  . please make the @anchor be a separate line, as it was before
  . the first sentence ("Is a query sent...") sounds awkward, suggest
    to reword "This is sent when connection is first ..."
  . please make sure to leave 2 spaces between sentences, per our
    conventions
  . please provide a suitable log message and ChangeLog change

Thanks.


More information about the Gdb-patches mailing list