Date: Sat, 18 Jan 2003 12:28:13 +0300
From: "Eli Zaretskii" <eliz AT is DOT elta DOT co DOT il>
Sender: halo1 AT zahav DOT net DOT il
To: djgpp-workers AT delorie DOT com
Message-Id: <7458-Sat18Jan2003122812+0200-eliz@is.elta.co.il>
X-Mailer: emacs 21.3.50 (via feedmail 8 I) and Blat ver 1.8.9
In-reply-to: <Pine.OSF.4.51.0301171344540.17854@sirppi.helsinki.fi> (message
	from Esa A E Peuha on Fri, 17 Jan 2003 14:15:12 +0200 (EET))
Subject: Re: Adding index entries to library docs
References:  <Pine DOT OSF DOT 4 DOT 51 DOT 0301171344540 DOT 17854 AT sirppi DOT helsinki DOT fi>
Reply-To: djgpp-workers AT delorie DOT com
Errors-To: nobody AT delorie DOT com
X-Mailing-List: djgpp-workers AT delorie DOT com
X-Unsubscribes-To: listserv AT delorie DOT com
Precedence: bulk

> Date: Fri, 17 Jan 2003 14:15:12 +0200 (EET)
> From: Esa A E Peuha <peuha AT cc DOT helsinki DOT fi>
> 
> http://www.helsinki.fi/~peuha/english/djgpp/indexdiff.txt

Thanks.  I downloaded and reviewed these patches.  I'm okay with
applying them, provided that the following minor issues are taken care
of (yes, I know that most of the errors were in the original text, but
as long as we are fixing the manual, we might as well fix these as
well.):

  +This array contains a list of the sizes of the memory regions allocated
  +by sbrk() in addition to the memory region allocated by the stub.  These

Please change "sbrk()" to "@code{sbrk}".  This will take care of two
problems: @code provides the right markup, and the "()" part makes the
text look as a call to `sbrk' with no arguments, which is not what we
are trying to say.

  +with laptops and "green" boxes which use it to wake up.  Default is to

Please change " to `` and ''.  This makes the quotes look much better
in the printed manual (the Info output will remain the same).

  +Protection Fault etc. (mapped to @code{SIGSEGV} signal); for these,

There should be a "@:" after "etc.", to prevent TeX from typesetting
this as the end of a sentence.

Finally, I think it would be good to add @vindex entries for all the
environment variables mentioned in libc.info, and also add @tindex
entries for every typedef and struct described in the manual.  @cindex
entries for important function categories would also help.  (I'm not
saying that you must do this as part of the patch you made, just that
it's worth doing, in the hope that someone will find time and
motivation for that.)