From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 1356 invoked by alias); 27 Dec 2001 08:48:51 -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 1329 invoked from network); 27 Dec 2001 08:48:49 -0000 Received: from unknown (HELO is.elta.co.il) (199.203.121.2) by sources.redhat.com with SMTP; 27 Dec 2001 08:48:49 -0000 Received: from is (is [199.203.121.2]) by is.elta.co.il (8.9.3/8.8.8) with SMTP id KAA19199; Thu, 27 Dec 2001 10:48:08 +0200 (IST) Date: Thu, 27 Dec 2001 00:48:00 -0000 From: Eli Zaretskii X-Sender: eliz@is To: Michael Snyder cc: gdb-patches@sources.redhat.com Subject: Re: [RFA] Doc for "maint info sections" command In-Reply-To: <200112261913.fBQJDiF26789@reddwarf.cygnus.com> Message-ID: MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII X-SW-Source: 2001-12/txt/msg00583.txt.bz2 On Wed, 26 Dec 2001, Michael Snyder wrote: > I haven't tested this, and I'm not sure whether the @table operator > can be nested? Yes, @table can be nested. > 2001-12-26 Michael Snyder > > * gdb.texinfo (maint info sections): Document. Thanks for writing this up. I have a few comments: > + @kindex maint info sections > + @item maint info sections > + Another command that can give you extra information about program sections > + is @code{maint info sections}. In addition to the section information > + displayed by @code{info files}, this command displays the flags and file > + offset of each section in the executable and core dump files. In addition, > + @code{maint info sections} provides the following command options (which > + may be arbitrarily combined): > + > + @table @code > + @kindex maint info sections ALLOBJ It is not useful to have several index entries that are so close to one another and all begin with the same string. What this produces in the printed manual is several successive entries in the index that all point to the same page. So please leave only the one @kindex maint info sections" above, and delete the others, which say "kindex maint info sections SOMETHING". > + @item @samp{
} Here, "
" is a ``metasyntactic variable'', something that should be replaced by specific strings from some set of possible strings. Metasyntactic variables should have the @var markup in Texinfo (which upcases them in the Info manual, and produces cursive font in the printed version). So here's how I'd suggest to rewrite the above @item: @item @var{sections} > + Display info only for section(s) matching the listed name(s). ...and then you can refer to @var{sections} in the text, like this: Display info only for named @var{sections}. > + @item @samp{
} > + Display info only for sections for which @samp{
} are true. > + The section flags that @value{GDBN} currently knows about are @code{ALLOC, > + LOAD, RELOC, READONLY, CODE, DATA, ROM, CONSTRUCTOR, HAS_CONTENTS, > + NEVER_LOAD, COFF_SHARED_LIBRARY,} and @code{IS_COMMON}. > + @end table Same here: @var{section-flags} in the @item, and then use @var{section-flags} in the text. Also, you will get a warning from makeinfo if you have commas inside @code; you should do it the hard way: @code{ALLOC}, @code{LOAD}, etc. Actually, I'd suggest to make the list of flags another @table, and perhaps explain some of them (ALLOC, CONSTRUCTOR, and HAS_CONTENTS are those which would leave me wondering, for example).