[01/26] Improve doc about "maint print c-tdesc"

Message ID 1499694940-23564-2-git-send-email-yao.qi@linaro.org
State New, archived
Headers

Commit Message

Yao Qi July 10, 2017, 1:55 p.m. UTC
  In my patch extending command "maint print c-tdesc"
(https://sourceware.org/ml/gdb-patches/2017-06/msg00286.html), Eli
raised some questions on the existing doc to this command.  It is not
very clear, so this patch improves it.  Eli approved it.

gdb/doc:

2017-06-30  Yao Qi  <yao.qi@linaro.org>

	* gdb.texinfo (Maintenance Commands): Improve the doc to
	command "maint print c-tdesc".
---
 gdb/doc/gdb.texinfo | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
  

Comments

Yao Qi July 18, 2017, 11:40 a.m. UTC | #1
Yao Qi <qiyaoltc@gmail.com> writes:

> In my patch extending command "maint print c-tdesc"
> (https://sourceware.org/ml/gdb-patches/2017-06/msg00286.html), Eli
> raised some questions on the existing doc to this command.  It is not
> very clear, so this patch improves it.  Eli approved it.
>
> gdb/doc:
>
> 2017-06-30  Yao Qi  <yao.qi@linaro.org>
>
> 	* gdb.texinfo (Maintenance Commands): Improve the doc to
> 	command "maint print c-tdesc".

I pushed it in.
  

Patch

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index c167a86..5f55a67 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -34690,8 +34690,9 @@  Print the entire architecture configuration.  The optional argument
 @kindex maint print c-tdesc
 @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.
+a C source file.  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.
 
 @kindex maint print dummy-frames
 @item maint print dummy-frames