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

[Yao Qi <qiyaoltc at gmail dot com>]

Eli Zaretskii <eliz@gnu.org> writes:

>> Yes.  The last sentence is about it, "The created source file is built
>> into @value{GDBN}", but I didn't explicitly say GDB needs rebuild.
>
> I think we should say that.
>
>> > (In general, since GDB is a compiled program which cannot easily be
>> > modified without rebuilding it, I wonder how useful this feature will
>> > be.  But I'll yield to your expertise on that.)
>> 
>> This command is only used by developers after they add or modify XML
>> target descriptions.
>
> Then I think we should say that as well.
>

I update the paragraph for this command a little bit,

@kindex maint print c-tdesc @r{[}@var{file}@r{]}
@item maint print c-tdesc
Print the target description (@pxref{Target Descriptions}) as
a C source file.  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 @var{file} should be an XML
document, of the form described in @ref{Target Description Format}.
The created source file is built into @value{GDBN} when @value{GDBN} is
built again.  This command is used by developers after they add or
modify XML target descriptions.

>> A question in general, do we really need to document these commands,
>> which are used for GDB development, in GDB user manual?  These
>> commands are "maint print c-tdesc", "maint check xml-descriptions"
>> (added by one patch in this series), and "maint selftest".  Can we
>> remove them from the user manual?
>
> If we remove them, there will be no place where they are documented,
> right?  GDB developers are GDB users as well, e.g. I read the manual
> quite a lot.
>
> So I see no reason to remove these commands.  We just need to indicate
> when a command makes sense only for GDB developers.

but GDB users are not GDB developers.  Why does user manual documents
some commands users never use?  IMO, these documents should be
documented in GDB internals.

-- 
Yao (齐尧)