[rfc/doco] bug reporting: mention 'script' command

[rfc/doco] bug reporting: mention 'script' command

[Michael Elizabeth Chastain]

Here's a bit of doco which mentions the 'script' command for bug reporting.
I've been wanting to do this for a while.

Testing: I rebuilt gdb to make sure the texinfo syntax is okay.

Comments on the syntax?
Comments on the content?

Michael C

2004-06-17  Michael Chastain  <mec.gnu@mindspring.com>

	gdb.texinfo (Bug Reporting): Mention the script command.

Index: gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.206
diff -c -3 -p -r1.206 gdb.texinfo
*** gdb.texinfo	14 Jun 2004 22:26:33 -0000	1.206
--- gdb.texinfo	17 Jun 2004 20:40:23 -0000
*************** ours fails to crash, we would know that 
*** 18960,18965 ****
--- 18960,18970 ----
  us.  If you had not told us to expect a crash, then we would not be able
  to draw any conclusion from our observations.
  
+ To collect all this information, you can use a session recording program
+ such as @command{script}, which is available on many Unix systems.
+ Just run your @value{GDBN} session inside @command{script} and then
+ include the @file{typescript} file with your bug report.
+ 
  @item
  If you wish to suggest changes to the @value{GDBN} source, send us context
  diffs.  If you even discuss something in the @value{GDBN} source, refer to

Re: [rfc/doco] bug reporting: mention 'script' command

[Eli Zaretskii]

> Date: Thu, 17 Jun 2004 16:52:52 -0400 (EDT)
> From: mec.gnu@mindspring.com (Michael Elizabeth Chastain)
> 
> Comments on the syntax?

None.

> Comments on the content?

Only one: I think it might be a good idea to add a "@pindex script"
entry before the new paragraph you added.

Btw, another way to record the GDB session is to run it inside Emacs
and then save the GUD (or shell) buffer to a file.  On some systems,
such as Windows, it might even be superior to `script', since the
latteer, even if you find a Windows port and install it, might not be
able to cope with all the wird types of console output GDB and
inferior programs use on Windows, so part of the session might end up
unrecorded.

Thanks.

Re: [rfc/doco] bug reporting: mention 'script' command

[Michael Elizabeth Chastain]

Okay, here's draft #2.  I mentioned Emacs as well as 'script'.
I added a @pindex and a @cindex.

Testing: Rebuilt gdb.info and checked the output files.

Okay to commit?

Michael C

2004-06-17  Michael Chastain  <mec.gnu@mindspring.com>

	gdb.texinfo (Bug Reporting): Mention session recording,
	with the script command or Emacs.

Index: gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.206
diff -c -3 -p -r1.206 gdb.texinfo
*** gdb.texinfo	14 Jun 2004 22:26:33 -0000	1.206
--- gdb.texinfo	18 Jun 2004 19:51:25 -0000
*************** ours fails to crash, we would know that 
*** 18960,18965 ****
--- 18960,18975 ----
  us.  If you had not told us to expect a crash, then we would not be able
  to draw any conclusion from our observations.
  
+ @pindex script
+ @cindex recording a session script
+ To collect all this information, you can use a session recording program
+ such as @command{script}, which is available on many Unix systems.
+ Just run your @value{GDBN} session inside @command{script} and then
+ include the @file{typescript} file with your bug report.
+ 
+ Another way to record a @value{GDBN} session is to run @value{GDBN}
+ inside Emacs and then save the entire buffer to a file.
+ 
  @item
  If you wish to suggest changes to the @value{GDBN} source, send us context
  diffs.  If you even discuss something in the @value{GDBN} source, refer to

Re: [rfc/doco] bug reporting: mention 'script' command

[Eli Zaretskii]

> Date: Fri, 18 Jun 2004 15:55:49 -0400 (EDT)
> From: mec.gnu@mindspring.com (Michael Elizabeth Chastain)
> 
> Okay, here's draft #2.  I mentioned Emacs as well as 'script'.
> I added a @pindex and a @cindex.
> 
> Testing: Rebuilt gdb.info and checked the output files.
> 
> Okay to commit?

Yes, thanks.

Re: [rfc/doco] bug reporting: mention 'script' command

[Michael Elizabeth Chastain]

Committed.

===

2004-06-17  Michael Chastain  <mec.gnu@mindspring.com>

	gdb.texinfo (Bug Reporting): Mention session recording,
	with the script command or Emacs.