Re: Fix "maint time" command documentation.

Anmol P. Paralkar
2010-07-02T17:03:40Z

On Fri, 2 Jul 2010, Eli Zaretskii wrote:

>> Date: Thu, 1 Jul 2010 18:20:49 -0500 (CDT)
>> From: "Anmol P. Paralkar" <anmol@freescale.com>
>>
>> The documentation for the "maint time" command does not mention the units of time.
>> Also, there are a couple of typos in there. I have attempted to fix these in the
>> following patch; please let me know if we could word/punctuate this better and
>> I'll be happy to re-spin.
>
> Thanks. I have a few suggestions for a better change:
>
>> Control whether to display the execution time for each command. If
>> set to a nonzero value, @value{GDBN} will display how much time it
>> ! took (in seconds) to execute each command, following the command's own output.
>
> It would be better to place the units right after "time":
>
> Control whether to display the execution time for each command.
> If set to a nonzero value, @value{GDBN} will display how much time
> (in seconds) it took to execute each command, following the
> command's own output.
>
>> ! The time is not printed for the commands that run on the target, since
>> there's no mechanism currently to compute how much time was spend
> ^^^^^
> "spent"
>
>> ! by @value{GDBN} and how much time was spend by the program been debugged;
> ^^^^^ ^^^^
> "spent" and "being"
>
>> ! this is not possible currently.
>
> I think this part is not needed. The sentence already says that
> "there's no mechanism currently" to do this, so this addition simply
> reiterates the same thing.
>
> Thanks.

Hello Eli,

Thank you for your suggestions; please see the new version with them, below.

Regards,
Anmol.

Index: ChangeLog
===================================================================
RCS file: /cvs/src/src/gdb/doc/ChangeLog,v
retrieving revision 1.1083
diff -c -p -r1.1083 ChangeLog
*** ChangeLog 1 Jul 2010 17:40:04 -0000 1.1083
--- ChangeLog 2 Jul 2010 16:54:42 -0000
***************
*** 1,3 ****
--- 1,8 ----
+ 2010-07-02 Anmol P. Paralkar <anmol@freescale.com>
+
+ * gdb.texinfo (Maintenance Commands): Mention units of time
+ and fix typos in documentation for command "maint time".
+
2010-07-01 Pedro Alves <pedro@codesourcery.com>

* gdb.texinfo (Create and Delete Tracepoints): Add more index
Index: gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.737
diff -c -p -r1.737 gdb.texinfo
*** gdb.texinfo 1 Jul 2010 17:40:04 -0000 1.737
--- gdb.texinfo 2 Jul 2010 16:54:44 -0000
*************** switch (@pxref{Mode Options}).
*** 30571,30585 ****
@kindex maint time
@cindex time of command execution
@item maint time
! Control whether to display the execution time for each command. If
! set to a nonzero value, @value{GDBN} will display how much time it
! took to execute each command, following the command's own output.
! The time is not printed for the commands that run the target, since
! there's no mechanism currently to compute how much time was spend
! by @value{GDBN} and how much time was spend by the program been debugged.
! it's not possibly currently
! This can also be requested by invoking @value{GDBN} with the
! @option{--statistics} command-line switch (@pxref{Mode Options}).

@kindex maint translate-address
@item maint translate-address @r{[}@var{section}@r{]} @var{addr}
--- 30571,30584 ----
@kindex maint time
@cindex time of command execution
@item maint time
! Control whether to display the execution time for each command.
! If set to a nonzero value, @value{GDBN} will display how much time
! (in seconds) it took to execute each command, following the command's
! own output. The time is not printed for the commands that run on the
! target, since there's no mechanism currently to compute how much time
! was spent by @value{GDBN} and how much time was spent by the program
! being debugged. This can also be requested by invoking @value{GDBN}
! with the @option{--statistics} command-line switch (@pxref{Mode Options}).

@kindex maint translate-address
@item maint translate-address @r{[}@var{section}@r{]} @var{addr}