From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 1243 invoked by alias); 10 Feb 2004 19:04:39 -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 1215 invoked from network); 10 Feb 2004 19:04:38 -0000 Received: from unknown (HELO hector.inter.net.il) (192.114.186.13) by sources.redhat.com with SMTP; 10 Feb 2004 19:04:38 -0000 Received: from zaretski ([80.230.146.111]) by hector.inter.net.il (MOS 3.4.4-GR) with ESMTP id AED15061; Tue, 10 Feb 2004 13:04:52 +0200 (IST) Date: Tue, 10 Feb 2004 19:04:00 -0000 From: "Eli Zaretskii" To: Elena Zannoni Message-Id: <6654-Tue10Feb2004210510+0200-eliz@elta.co.il> CC: gdb-patches@sources.redhat.com In-reply-to: <16425.5280.824503.7068@localhost.redhat.com> (message from Elena Zannoni on Tue, 10 Feb 2004 12:28:00 -0500) Subject: Re: [RFA/doco] add obstacks to gdbint.texi Reply-to: Eli Zaretskii References: <16425.5280.824503.7068@localhost.redhat.com> X-SW-Source: 2004-02/txt/msg00247.txt.bz2 > From: Elena Zannoni > Date: Tue, 10 Feb 2004 12:28:00 -0500 > > Eli, I am sure it's not perfect. Actually, it's quite close. > How do I quote function names, for instance? Any programming-language symbol should have the @code markup: @code{xmalloc}, @code{xrealloc}, etc. > +@cindex libiberty library > + > +The libiberty library provides a set of functions and features that "libiberty" is (almost) a file name, so it should be in @file, both in the index entry and in the text. > +@value{GDBN} uses various features provided by the libiberty library, > +for instance the memory management functions xfree and xmalloc, and > +the obstack extension. I would put "obstack" either in @code or in @samp. > +@subsection obstacks in @value{GDBN} Please add a @cindex entry here so that people could find the info about obstacks quickly. > +a stack. Objects (of any nature, size and alignment) are allocated and > +freed in a LIFO fashion on an obstack. (See the libiberty's "LIFO" is an acronym, so it's better to say "@acronym{LIFO}"; the result after typesetting by TeX will look prettier. Finally, there are many places where there's only one blank after a dot that ends a sentence. Please make that 2 spaces. Last, but certainly not least, thanks for taking time to write this.