From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 16970 invoked by alias); 13 Mar 2004 16:23:57 -0000 Mailing-List: contact gdb-patches-help@sources.redhat.com; run by ezmlm Precedence: bulk List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sources.redhat.com Received: (qmail 16961 invoked from network); 13 Mar 2004 16:23:56 -0000 Received: from unknown (HELO aragorn.inter.net.il) (192.114.186.23) by sources.redhat.com with SMTP; 13 Mar 2004 16:23:56 -0000 Received: from zaretski (pns03-199-205.inter.net.il [80.230.199.205]) by aragorn.inter.net.il (MOS 3.4.4-GR) with ESMTP id CPG06096; Sat, 13 Mar 2004 18:23:43 +0200 (IST) Date: Sat, 13 Mar 2004 16:23:00 -0000 From: "Eli Zaretskii" To: Stephane Carrez Message-ID: <6480-Sat13Mar2004182210+0200-eliz@elta.co.il> CC: gdb-patches@sources.redhat.com In-reply-to: <405318FE.8000904@nerim.fr> (message from Stephane Carrez on Sat, 13 Mar 2004 15:21:50 +0100) Subject: Re: [RFA]: Document tui reg commands Reply-to: Eli Zaretskii References: <405318FE.8000904@nerim.fr> X-SW-Source: 2004-03.o/txt/msg00304.txt Message-ID: <20040313162300.5faNZangdDF5FRJy6NR7-WxEaMP5bXuQmMrf7LN3s5E@z> > Date: Sat, 13 Mar 2004 15:21:50 +0100 > From: Stephane Carrez > > This is the documentation part of the new TUI reg commands. Thanks. > Ok to commit? Yes, but please fix the following small gotchas: > +@item tui reg float > +@kindex tui reg float > +Show the floating point registers in the register window. > + > +@item tui reg general > +@kindex tui reg general > +Show the general registers in the register window. > + > +@item tui reg next > +@kindex tui reg next There's no need to make a @kindex entry for all the 3 variants of this command; a single "@kindex tui reg" will do. In general, it's not useful to have several index entries that all begin with the same string and all point to the same page, because that doesn't add any information to someone who is looking through the index. > + [...] The predefined register groups are the > +following: @code{general}, @code{float}, @code{system}, @code{vector}, > +@code{all}, @code{save}, @code{restore}. > + > +@item tui reg system > +@kindex tui reg system > +Show the system registers in the register window. I think we should have a description of at least some of these predefined register groups. For example, I could probably easily guess what "reg float" or "reg vector" mean, but I have no idea about "reg system" or "reg save/restore". I'm afraid a description such as "Show the system registers in the register window." doesn't help me to unlock this mystery.