[RFA]: Document TUI status line

[RFA]: Document TUI status line

[Stephane Carrez]

[-- Attachment #1: Type: text/plain, Size: 282 bytes --]

Hi!

This patch documents the TUI status line fields.  I've used @emph for table
because the items are not printed as is.  Checked on pdf.

Is it ok to commit?

	Stephane

2002-09-01  Stephane Carrez  <stcarrez@nerim.fr>

	* gdb.texinfo (TUI Overview): Document status line fields.

[-- Attachment #2: gdb-status.diffs --]
[-- Type: text/plain, Size: 1343 bytes --]

Index: gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.117
diff -u -p -r1.117 gdb.texinfo
--- gdb.texinfo	1 Sep 2002 08:52:36 -0000	1.117
+++ gdb.texinfo	1 Sep 2002 17:07:36 -0000
@@ -13209,6 +13209,35 @@ assembly and registers
 
 @end itemize
 
+On top of the command window a status line gives various information
+concerning the current process begin debugged.  The status line is
+updated when the information it shows changes.  The following fields
+are displayed:
+
+@table @emph
+@item target
+Indicates the current gdb target
+(@pxref{Targets, ,Specifying a Debugging Target}).
+
+@item process
+Gives information about the current process or thread number.
+When no process is being debugged, this field is set to @code{No process}.
+
+@item function
+Gives the current function name for the selected frame.
+The name is demangled if demangling is turned on.
+When there is no symbol corresponding to the current PC
+the string @code{??} is displayed.
+
+@item line
+Indicates the current line number for the selected frame.
+When the current line number is not known the string @code{??} is displayed.
+
+@item pc
+Indicates the current PC address.
+
+@end table
+
 @node TUI Keys
 @section TUI Key Bindings
 @cindex TUI key bindings

Re: [RFA]: Document TUI status line

[Eli Zaretskii]

On Sun, 1 Sep 2002, Stephane Carrez wrote:

> This patch documents the TUI status line fields.  I've used @emph for table
> because the items are not printed as is.  Checked on pdf.
> 
> Is it ok to commit?

Yes, with these two minor comments:

 - After this sentence:

   The name is demangled if demangling is turned on.

   I suggest a cross reference to the place where the manual describes 
   how to control demangling.

 - I suggest to say "program counter" instead of "PC", in case the reader 
   is not fluent with the GDB parlance.

Thanks!