[6.1] TUI in doco?

[6.1] TUI in doco?

[Andrew Cagney]

Eli,

Any ideas on how to introduce "gdbtui" into the doco?  Once that's 
resolved, I think 6.1 is shippable.

Andrew

Re: [6.1] TUI in doco?

[Eli Zaretskii]

> Date: Tue, 16 Mar 2004 17:54:21 -0500
> From: Andrew Cagney <cagney@gnu.org>
> 
> Any ideas on how to introduce "gdbtui" into the doco?

I think we already discussed that; my suggestions are in this message:

   http://sources.redhat.com/ml/gdb-patches/2004-02/msg00278.html

Re: [6.1] TUI in doco?

[Eli Zaretskii]

> Date: Tue, 16 Mar 2004 17:54:21 -0500
> From: Andrew Cagney <cagney@gnu.org>
> 
> Any ideas on how to introduce "gdbtui" into the doco?

I think we already discussed that; my suggestions are in this message:

   http://sources.redhat.com/ml/gdb-patches/2004-02/msg00278.html

Re: [6.1] TUI in doco?

[Andrew Cagney]

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

>>> Date: Tue, 16 Mar 2004 17:54:21 -0500
>>> From: Andrew Cagney <cagney@gnu.org>
>>> 
>>> Any ideas on how to introduce "gdbtui" into the doco?
> 
> 
> I think we already discussed that; my suggestions are in this message:
> 
>    http://sources.redhat.com/ml/gdb-patches/2004-02/msg00278.html

The attached is hopefully getting there.  I also noticed an 
inconsistency in its name.  "Terminal User Interface" is what HP use, it 
fixes that as well.

Andrew


[-- Attachment #2: diffs --]
[-- Type: text/plain, Size: 3121 bytes --]

2004-03-22  Andrew Cagney  <cagney@redhat.com>

	* gdb.texinfo (TUI): Delete reference to --enable-tui.  Mention
	"gdbtui".
	(Mode Options): Mention "gdbtui".
	(TUI): Rename chapter to "Terminal User Interface".

Index: doc/gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.200
diff -u -r1.200 gdb.texinfo
--- doc/gdb.texinfo	9 Mar 2004 16:16:35 -0000	1.200
+++ doc/gdb.texinfo	22 Mar 2004 21:27:30 -0000
@@ -142,7 +142,7 @@
 * Configurations::              Configuration-specific information
 * Controlling GDB::             Controlling @value{GDBN}
 * Sequences::                   Canned sequences of commands
-* TUI::                         @value{GDBN} Text User Interface
+* TUI::                         @value{GDBN} Terminal User Interface
 * Interpreters::		Command Interpreters
 * Emacs::                       Using @value{GDBN} under @sc{gnu} Emacs
 * Annotations::                 @value{GDBN}'s annotation interface.
@@ -1112,12 +1112,14 @@
 @c resolve the situation of these eventually
 @item -tui
 @cindex @code{--tui}
-Activate the Terminal User Interface when starting.
-The Terminal User Interface manages several text windows on the terminal,
-showing source, assembly, registers and @value{GDBN} command outputs
-(@pxref{TUI, ,@value{GDBN} Text User Interface}).
-Do not use this option if you run @value{GDBN} from Emacs
-(@pxref{Emacs, ,Using @value{GDBN} under @sc{gnu} Emacs}).
+@pindex @code{gdbtui}
+Activate the Terminal User Interface when starting.  The Terminal User
+Interface manages several text windows on the terminal, showing
+source, assembly, registers and @value{GDBN} command outputs
+(@pxref{TUI, ,@value{GDBN} Terminal User Interface}).  Alternatively,
+the Terminal User Interface can be enabled by invoking the program
+@samp{gdbtui}.  Do not use this option if you run @value{GDBN} from
+Emacs (@pxref{Emacs, ,Using @value{GDBN} under @sc{gnu} Emacs}).
 
 @c @item -xdb
 @c @cindex @code{--xdb}
@@ -13886,7 +13888,7 @@
 @value{GDBN} which support @sc{gdb/mi} version 2 (or greater).
 
 @node TUI
-@chapter @value{GDBN} Text User Interface
+@chapter @value{GDBN} Terminal User Interface
 @cindex TUI
 
 @menu
@@ -13897,12 +13899,14 @@
 * TUI Configuration::           TUI configuration variables
 @end menu
 
-The @value{GDBN} Text User Interface, TUI in short,
-is a terminal interface which uses the @code{curses} library
-to show the source file, the assembly output, the program registers
-and @value{GDBN} commands in separate text windows.
-The TUI is available only when @value{GDBN} is configured
-with the @code{--enable-tui} configure option (@pxref{Configure Options}).
+The @value{GDBN} Terminal User Interface, TUI in short, is a terminal
+interface which uses the @code{curses} library to show the source
+file, the assembly output, the program registers and @value{GDBN}
+commands in separate text windows.
+
+The TUI is enabled by invoking @value{GDBN} using either
+@pindex gdbtui
+@samp{gdbtui} or @samp{gdb -tui}.
 
 @node TUI Overview
 @section TUI overview

Re: [6.1] TUI in doco?

[Eli Zaretskii]

> Date: Mon, 22 Mar 2004 16:30:24 -0500
> From: Andrew Cagney <cagney@gnu.org>
> 
> The attached is hopefully getting there.

Thanks.  My comments below.

> I also noticed an inconsistency in its name.  "Terminal User
> Interface" is what HP use, it fixes that as well.

FWIW, the previous interpretation of TUI was better: it's a text-mode
UI; "terminal" doesn't necessarily imply "text-mode".  Oh well...

> +@pindex @code{gdbtui}

There's no need to use @code in @pindex entries, these entries are
automatically typeset in the same typeface as arguments of @code.

> +Activate the Terminal User Interface when starting.  The Terminal User

The first occurence of "Terminal User Interface" would look better in
@dfn.  Also, a @cindex entry for "Terminal User Interface" somewhere,
probably where you have an index entry for TUI, could be a good idea.

> +The TUI is enabled by invoking @value{GDBN} using either
> +@pindex gdbtui
> +@samp{gdbtui} or @samp{gdb -tui}.

This is the second time we have a @pindex entry about gdbtui; one of
them is redundant and should be removed, I think.

Otherwise, fine with me.

Re: [6.1] TUI in doco?

[Andrew Cagney]

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

>>> Date: Mon, 22 Mar 2004 16:30:24 -0500
>>> From: Andrew Cagney <cagney@gnu.org>
>>> 
>>> The attached is hopefully getting there.
> 
> 
> Thanks.  My comments below.
> 
> 
>>> I also noticed an inconsistency in its name.  "Terminal User
>>> Interface" is what HP use, it fixes that as well.
> 
> 
> FWIW, the previous interpretation of TUI was better: it's a text-mode
> UI; "terminal" doesn't necessarily imply "text-mode".  Oh well...
> 
> 
>>> +@pindex @code{gdbtui}
> 
> 
> There's no need to use @code in @pindex entries, these entries are
> automatically typeset in the same typeface as arguments of @code.

I've removed this entry.  That leaves just the entry pointing at the 
chapter proper.

>>> +Activate the Terminal User Interface when starting.  The Terminal User
> 
> 
> The first occurence of "Terminal User Interface" would look better in
> @dfn.  Also, a @cindex entry for "Terminal User Interface" somewhere,
> probably where you have an index entry for TUI, could be a good idea.

Done (it's now text user interface).

>>> +The TUI is enabled by invoking @value{GDBN} using either
>>> +@pindex gdbtui
>>> +@samp{gdbtui} or @samp{gdb -tui}.
> 
> 
> This is the second time we have a @pindex entry about gdbtui; one of
> them is redundant and should be removed, I think.

Ok, see attached.

Andrew


[-- Attachment #2: diffs --]
[-- Type: text/plain, Size: 3121 bytes --]

2004-03-22  Andrew Cagney  <cagney@redhat.com>

	* gdb.texinfo (TUI): Delete reference to --enable-tui.  Mention
	"gdbtui".
	(Mode Options): Mention "gdbtui".
	(TUI): Rename chapter to "Terminal User Interface".

Index: doc/gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.200
diff -u -r1.200 gdb.texinfo
--- doc/gdb.texinfo	9 Mar 2004 16:16:35 -0000	1.200
+++ doc/gdb.texinfo	22 Mar 2004 21:27:30 -0000
@@ -142,7 +142,7 @@
 * Configurations::              Configuration-specific information
 * Controlling GDB::             Controlling @value{GDBN}
 * Sequences::                   Canned sequences of commands
-* TUI::                         @value{GDBN} Text User Interface
+* TUI::                         @value{GDBN} Terminal User Interface
 * Interpreters::		Command Interpreters
 * Emacs::                       Using @value{GDBN} under @sc{gnu} Emacs
 * Annotations::                 @value{GDBN}'s annotation interface.
@@ -1112,12 +1112,14 @@
 @c resolve the situation of these eventually
 @item -tui
 @cindex @code{--tui}
-Activate the Terminal User Interface when starting.
-The Terminal User Interface manages several text windows on the terminal,
-showing source, assembly, registers and @value{GDBN} command outputs
-(@pxref{TUI, ,@value{GDBN} Text User Interface}).
-Do not use this option if you run @value{GDBN} from Emacs
-(@pxref{Emacs, ,Using @value{GDBN} under @sc{gnu} Emacs}).
+@pindex @code{gdbtui}
+Activate the Terminal User Interface when starting.  The Terminal User
+Interface manages several text windows on the terminal, showing
+source, assembly, registers and @value{GDBN} command outputs
+(@pxref{TUI, ,@value{GDBN} Terminal User Interface}).  Alternatively,
+the Terminal User Interface can be enabled by invoking the program
+@samp{gdbtui}.  Do not use this option if you run @value{GDBN} from
+Emacs (@pxref{Emacs, ,Using @value{GDBN} under @sc{gnu} Emacs}).
 
 @c @item -xdb
 @c @cindex @code{--xdb}
@@ -13886,7 +13888,7 @@
 @value{GDBN} which support @sc{gdb/mi} version 2 (or greater).
 
 @node TUI
-@chapter @value{GDBN} Text User Interface
+@chapter @value{GDBN} Terminal User Interface
 @cindex TUI
 
 @menu
@@ -13897,12 +13899,14 @@
 * TUI Configuration::           TUI configuration variables
 @end menu
 
-The @value{GDBN} Text User Interface, TUI in short,
-is a terminal interface which uses the @code{curses} library
-to show the source file, the assembly output, the program registers
-and @value{GDBN} commands in separate text windows.
-The TUI is available only when @value{GDBN} is configured
-with the @code{--enable-tui} configure option (@pxref{Configure Options}).
+The @value{GDBN} Terminal User Interface, TUI in short, is a terminal
+interface which uses the @code{curses} library to show the source
+file, the assembly output, the program registers and @value{GDBN}
+commands in separate text windows.
+
+The TUI is enabled by invoking @value{GDBN} using either
+@pindex gdbtui
+@samp{gdbtui} or @samp{gdb -tui}.
 
 @node TUI Overview
 @section TUI overview

Re: [6.1] TUI in doco?

[Eli Zaretskii]

> Date: Thu, 25 Mar 2004 11:26:04 -0500
> From: Andrew Cagney <cagney@gnu.org>
> 
> Ok, see attached.

Ahm.. that's exactly the previous patch you posted, I think.

Re: [6.1] TUI in doco?

[Andrew Cagney]

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

Doh!

[-- Attachment #2: diffs --]
[-- Type: text/plain, Size: 3397 bytes --]

2004-03-25  Andrew Cagney  <cagney@redhat.com>

	* gdb.texinfo (TUI): Delete reference to --enable-tui.  Mention
	"gdbtui".
	(Mode Options): Mention "gdbtui".  Use "Text" not "Terminal".
	(Contributors): Mention both Text and Terminal User Interface.

Index: gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.200
diff -u -r1.200 gdb.texinfo
--- gdb.texinfo	9 Mar 2004 16:16:35 -0000	1.200
+++ gdb.texinfo	25 Mar 2004 16:22:03 -0000
@@ -445,10 +445,10 @@
 The following people at the Hewlett-Packard Company contributed
 support for the PA-RISC 2.0 architecture, HP-UX 10.20, 10.30, and 11.0
 (narrow mode), HP's implementation of kernel threads, HP's aC@t{++}
-compiler, and the terminal user interface: Ben Krepp, Richard Title,
-John Bishop, Susan Macchia, Kathy Mann, Satish Pai, India Paul, Steve
-Rehrauer, and Elena Zannoni.  Kim Haase provided HP-specific
-information in this manual.
+compiler, and the Text User Interface (nee Terminal User Interface):
+Ben Krepp, Richard Title, John Bishop, Susan Macchia, Kathy Mann,
+Satish Pai, India Paul, Steve Rehrauer, and Elena Zannoni.  Kim Haase
+provided HP-specific information in this manual.
 
 DJ Delorie ported @value{GDBN} to MS-DOS, for the DJGPP project.
 Robert Hoehne made significant contributions to the DJGPP port.
@@ -1112,12 +1112,13 @@
 @c resolve the situation of these eventually
 @item -tui
 @cindex @code{--tui}
-Activate the Terminal User Interface when starting.
-The Terminal User Interface manages several text windows on the terminal,
-showing source, assembly, registers and @value{GDBN} command outputs
-(@pxref{TUI, ,@value{GDBN} Text User Interface}).
-Do not use this option if you run @value{GDBN} from Emacs
-(@pxref{Emacs, ,Using @value{GDBN} under @sc{gnu} Emacs}).
+Activate the @dfn{Text User Interface} when starting.  The Text User
+Interface manages several text windows on the terminal, showing
+source, assembly, registers and @value{GDBN} command outputs
+(@pxref{TUI, ,@value{GDBN} Text User Interface}).  Alternatively, the
+Text User Interface can be enabled by invoking the program
+@samp{gdbtui}.  Do not use this option if you run @value{GDBN} from
+Emacs (@pxref{Emacs, ,Using @value{GDBN} under @sc{gnu} Emacs}).
 
 @c @item -xdb
 @c @cindex @code{--xdb}
@@ -13888,6 +13889,7 @@
 @node TUI
 @chapter @value{GDBN} Text User Interface
 @cindex TUI
+@cindex Text User Interface
 
 @menu
 * TUI Overview::                TUI overview
@@ -13897,12 +13899,14 @@
 * TUI Configuration::           TUI configuration variables
 @end menu
 
-The @value{GDBN} Text User Interface, TUI in short,
-is a terminal interface which uses the @code{curses} library
-to show the source file, the assembly output, the program registers
-and @value{GDBN} commands in separate text windows.
-The TUI is available only when @value{GDBN} is configured
-with the @code{--enable-tui} configure option (@pxref{Configure Options}).
+The @value{GDBN} Text User Interface, TUI in short, is a terminal
+interface which uses the @code{curses} library to show the source
+file, the assembly output, the program registers and @value{GDBN}
+commands in separate text windows.
+
+The TUI is enabled by invoking @value{GDBN} using either
+@pindex gdbtui
+@samp{gdbtui} or @samp{gdb -tui}.
 
 @node TUI Overview
 @section TUI overview

Re: [6.1] TUI in doco?

[Eli Zaretskii]

> Date: Thu, 25 Mar 2004 15:40:05 -0500
> From: Andrew Cagney <cagney@gnu.org>
> 
> Doh!

Thanks, this patch is okay.

Re: [6.1] TUI in doco?

[Andrew Cagney]

>>> Date: Thu, 25 Mar 2004 15:40:05 -0500
>>> From: Andrew Cagney <cagney@gnu.org>
>>> 
>>> Doh!
> 
> 
> Thanks, this patch is okay.

Committed, mainline and 6.1 branch.

Andrew

[6.1] TUI in doco?

[Andrew Cagney]

Eli,

Any ideas on how to introduce "gdbtui" into the doco?  Once that's 
resolved, I think 6.1 is shippable.

Andrew

Re: [6.1] TUI in doco? (compiler errors)

[Manoj Iyer]

I dont know how much you care abt this for 6.1 to be shippable...

I get compiler errors compiling TUI, I am compiling GDB as a 64bit binary
on a ppc64 machine, I saw similar compiler errors in ppc-linux-tdep.c,
because it contained an enum as follows...

enum {
  ELF_NGREG = 48,
  ELF_NFPREG = 33,
  ELF_NVRREG = 33
};

ELF_XXX are already defined in a header file, so this breaks the build
beause the latest GCC sees 48 = 48.

I see similar messages with TUI build.

-I./../readline/.. -I../bfd -I./../bfd -I./../include -I../intl
-I./../intl  -DMI_OUT=1 -DTUI=1 -Wimplicit -Wreturn-type -Wcomment
-Wtrigraphs -Wformat -Wparentheses -Wpointer-arith -Wuninitialized
-Wformat-nonliteral -Wunused-label -Wunused-function  ./tui/tui-command.c
cc1: warning: -Wuninitialized is not supported without -O
In file included from tui/tui-command.c:28:
tui/tui-data.h:40: error: parse error before "WINDOW"
tui/tui-data.h:40: warning: no semicolon at end of struct or union
tui/tui-data.h:52: error: parse error before '}' token
tui/tui-data.h:224: error: field `data_window' has incomplete type
tui/tui-data.h:278: error: field `generic' has incomplete type
In file included from tui/tui-command.c:29:

:
:
:
:

tui/tui-command.c:91: error: `KEY_NPAGE' undeclared (first use in this
function)
tui/tui-command.c:108: error: `KEY_DOWN' undeclared (first use in this
function)
tui/tui-command.c:109: error: `KEY_SF' undeclared (first use in this
function)
tui/tui-command.c:112: error: `KEY_UP' undeclared (first use in this
function)
tui/tui-command.c:113: error: `KEY_SR' undeclared (first use in this
function)
tui/tui-command.c:116: error: `KEY_RIGHT' undeclared (first use in this
function)
tui/tui-command.c:119: error: `KEY_LEFT' undeclared (first use in this
function)
make[1]: *** [tui-command.o] Error 1
make[1]: Leaving directory `/root/gdb6.1/mar16/gdb'
make: *** [all-gdb] Error 2

I am looking at which definitions are missing, or re-defined.

Thanks
Manoj Iyer

On Tue, 16 Mar 2004, Andrew Cagney wrote:

> Eli,
>
> Any ideas on how to introduce "gdbtui" into the doco?  Once that's
> resolved, I think 6.1 is shippable.
>
> Andrew
>
>

Re: [6.1] TUI in doco? (compiler errors)

[Manoj Iyer]

I dont know how much you care abt this for 6.1 to be shippable...

I get compiler errors compiling TUI, I am compiling GDB as a 64bit binary
on a ppc64 machine, I saw similar compiler errors in ppc-linux-tdep.c,
because it contained an enum as follows...

enum {
  ELF_NGREG = 48,
  ELF_NFPREG = 33,
  ELF_NVRREG = 33
};

ELF_XXX are already defined in a header file, so this breaks the build
beause the latest GCC sees 48 = 48.

I see similar messages with TUI build.

-I./../readline/.. -I../bfd -I./../bfd -I./../include -I../intl
-I./../intl  -DMI_OUT=1 -DTUI=1 -Wimplicit -Wreturn-type -Wcomment
-Wtrigraphs -Wformat -Wparentheses -Wpointer-arith -Wuninitialized
-Wformat-nonliteral -Wunused-label -Wunused-function  ./tui/tui-command.c
cc1: warning: -Wuninitialized is not supported without -O
In file included from tui/tui-command.c:28:
tui/tui-data.h:40: error: parse error before "WINDOW"
tui/tui-data.h:40: warning: no semicolon at end of struct or union
tui/tui-data.h:52: error: parse error before '}' token
tui/tui-data.h:224: error: field `data_window' has incomplete type
tui/tui-data.h:278: error: field `generic' has incomplete type
In file included from tui/tui-command.c:29:

:
:
:
:

tui/tui-command.c:91: error: `KEY_NPAGE' undeclared (first use in this
function)
tui/tui-command.c:108: error: `KEY_DOWN' undeclared (first use in this
function)
tui/tui-command.c:109: error: `KEY_SF' undeclared (first use in this
function)
tui/tui-command.c:112: error: `KEY_UP' undeclared (first use in this
function)
tui/tui-command.c:113: error: `KEY_SR' undeclared (first use in this
function)
tui/tui-command.c:116: error: `KEY_RIGHT' undeclared (first use in this
function)
tui/tui-command.c:119: error: `KEY_LEFT' undeclared (first use in this
function)
make[1]: *** [tui-command.o] Error 1
make[1]: Leaving directory `/root/gdb6.1/mar16/gdb'
make: *** [all-gdb] Error 2

I am looking at which definitions are missing, or re-defined.

Thanks
Manoj Iyer

On Tue, 16 Mar 2004, Andrew Cagney wrote:

> Eli,
>
> Any ideas on how to introduce "gdbtui" into the doco?  Once that's
> resolved, I think 6.1 is shippable.
>
> Andrew
>
>

Re: [6.1] TUI in doco? (compiler errors)

[Andrew Cagney]

> I dont know how much you care abt this for 6.1 to be shippable...
> 
> I get compiler errors compiling TUI, I am compiling GDB as a 64bit binary
> on a ppc64 machine, I saw similar compiler errors in ppc-linux-tdep.c,
> because it contained an enum as follows...

I think this was identified as Novell specific?  What final include file 
and sequence of includes caused the problem?

> enum {
>   ELF_NGREG = 48,
>   ELF_NFPREG = 33,
>   ELF_NVRREG = 33
> };
> 
> ELF_XXX are already defined in a header file, so this breaks the build
> beause the latest GCC sees 48 = 48.
> 
> I see similar messages with TUI build.
> 
> -I./../readline/.. -I../bfd -I./../bfd -I./../include -I../intl
> -I./../intl  -DMI_OUT=1 -DTUI=1 -Wimplicit -Wreturn-type -Wcomment
> -Wtrigraphs -Wformat -Wparentheses -Wpointer-arith -Wuninitialized
> -Wformat-nonliteral -Wunused-label -Wunused-function  ./tui/tui-command.c
> cc1: warning: -Wuninitialized is not supported without -O
> In file included from tui/tui-command.c:28:
> tui/tui-data.h:40: error: parse error before "WINDOW"
> tui/tui-data.h:40: warning: no semicolon at end of struct or union
> tui/tui-data.h:52: error: parse error before '}' token
> tui/tui-data.h:224: error: field `data_window' has incomplete type
> tui/tui-data.h:278: error: field `generic' has incomplete type
> In file included from tui/tui-command.c:29:

You're going to need to provide a lot more detail.

Andrew