This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH 06/25] Generate c for feature instead of tdesc


> From: Yao Qi <qiyaoltc@gmail.com>
> Date: Mon, 12 Jun 2017 09:41:37 +0100
> 
> gdb/doc:
> 
> 2017-06-08  Yao Qi  <yao.qi@linaro.org>
> 
> 	* gdb.texinfo (Maintenance Commands): Document optional
> 	argument of "maint print c-tdesc".

Thanks.

> -@kindex maint print c-tdesc
> +@kindex maint print c-tdesc @r{[}@var{file}@r{]}
>  @item maint print c-tdesc
> -Print the current target description (@pxref{Target Descriptions}) as
> -a C source file.  The created source file can be used in @value{GDBN}
> -when an XML parser is not available to parse the description.
> +Print the target description (@pxref{Target Descriptions}) as
> +a C source file.  The target description is got from the optional
                                            ^^^^^^
"is produced", I guess?  Or maybe I don't understand what you mean by
"is got" here.

> +argument @var{file} or the current target description.

I think this should be described in the reverse order:

  By default, the target description is for the current target, but if
  the optional argument @var{file} is provided, that file is used to
  produce the description.

>                                                        The created
> +source file can be used in @value{GDBN} when an XML parser is not
> +available to parse the description.

I also have some clarification requests (and I do realize that the
original text had the same issues):

 . I think we should say a few words regarding the argument FILE: I
   don't believe _any_ file will do in this role, so we should tell
   what kind of files are expected here.
 . "The created source file can be used in GDB ..." -- used how?  I'd
   prefer that we said a sentence or tow about that as well, or had a
   cross-reference to where that is described.

Also, what about a NEWS entry?


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]