Re: [RFA/doco] add obstacks to gdbint.texi

["Eli Zaretskii" <eliz@elta.co.il>]

> From: Elena Zannoni <ezannoni@redhat.com>
> 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.