Re: mi tty commands

[Eli Zaretskii <eliz at gnu dot org>]

> Date: Wed, 1 Jun 2005 13:41:49 -0400
> From: Bob Rossi <bob@brasko.net>
> 
> Here's the whole patch, inlcuding the doco.

Thanks.

> Index: gdb/doc/ChangeLog
> +	* gdb.texinfo (GDB/MI Miscellaneous Commands): Add -inferior-tty-set.
> +	(GDB/MI Miscellaneous Commands): Add -inferior-tty-show.
> +	(Input/Output): Document "set/show inferior-tty".

There's no need to mention the same node twice.  I suggest to reformat
as follows:

	* gdb.texinfo (GDB/MI Miscellaneous Commands): Add -inferior-tty-set.
	and -inferior-tty-show.
	(Input/Output): Document "set/show inferior-tty".

> RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
> retrieving revision 1.258
> diff -w -u -r1.258 gdb.texinfo
> --- gdb/doc/gdb.texinfo	29 May 2005 03:13:18 -0000	1.258
> +++ gdb/doc/gdb.texinfo	1 Jun 2005 17:12:45 -0000
> @@ -2090,6 +2090,22 @@
>  command, only the input @emph{for your program} is affected.  The input
>  for @value{GDBN} still comes from your terminal.
>  
> +@vindex inferior-tty

Please don't use @vindex for the "set SOMETHING" commands, we don't do
that in GDB.  @vindex is generally reserved for convenience variables.

I suggest to have a "@cindex inferior tty" entry, though.

> +@cindex Set the inferior controlling terminal

Please remove "the", and please don't start the index entries with a
capital letter.  The convention in GDB (and the preferred style in
any manual) is not to capitalize index entries.

> +Yet another way to tell @value{GDBN} where you program should do input
> +and output is with the @code{set inferior-tty} command.  This is currently
> +the same as using the @code{tty} command.

If we do what I think we should do, i.e. make "tty" an alias to "set
inferior-tty", this paragraph will have to be rewritten.