Re: Merging OC gdb with official gdb

[Eli Zaretskii <eliz at is dot elta dot co dot il>]

On Mon, 23 Sep 2002, Marko Mlinar wrote:

> > How is your texinfo?
> here:

Thanks, this is okay with me, provided that you fix the following minor 
problems:

> + @node OpenRISC 1000
> + @subsection OpenRISC 1000

Please add a "@cindex OpenRISC 1000" here.

> + @cindex or1k boards
> + See OR1k Architecture document (@url{www.opencores.org}) for more information

Please avoid using @url at all costs; it's deprecated and not very 
useful.  Instead, use @uref, like this:

  See @uref{http://www.opencores.org, OR1k Architecture document}, for 
  more information

This will actually produce a link in HTML output, while Info and plain 
ASCII output will look almost like what you wrote above.

> + @item info or1k spr @var{group}
> + @item info or1k spr @var{groupno}
> + Displays register names in selected group.
> +
> + @item info or1k spr @var{group} @var{register}
> + @item info or1k spr @var{register}
> + @item info or1k spr @var{groupno} @var{registerno}
> + @item info or1k spr @var{registerno}
> + Shows information about specified spr register.

You want all @item's but the first be @itemx, like this:

  @item info or1k spr @var{group} @var{register}
  @itex info or1k spr @var{register}
  @itemx info or1k spr @var{groupno} @var{registerno}
  @itemx info or1k spr @var{registerno}
  Shows information about specified spr register.

> + @kindex htrace info
> + @item htrace info
> + Display information about current HW trace configuration.

I wonder whether it would be useful to say something about htrace -- what 
it is and what is it useful for.  It's something that isn't described 
anywhere else in the manual, so users might not know about it.

> + @kindex htrace enable
> + @item htrace enable
> + @kindex htrace disable
> + @item htrace disable
> + Enables/disables the HW trace.

Here, too, you want the second @item to be @itemx.