Date: Mon, 13 Aug 2001 21:37:59 +0300
From: "Eli Zaretskii" <eliz AT is DOT elta DOT co DOT il>
Sender: halo1 AT zahav DOT net DOT il
To: sandmann AT clio DOT rice DOT edu
Message-Id: <3942-Mon13Aug2001213759+0300-eliz@is.elta.co.il>
X-Mailer: Emacs 20.6 (via feedmail 8.3.emacs20_6 I) and Blat ver 1.8.9
CC: djgpp-workers AT delorie DOT com
In-reply-to: <10108131504.AA14030@clio.rice.edu> (sandmann@clio.rice.edu)
Subject: Re: Latest crt0 patches (+block sizing for core)
References:  <10108131504 DOT AA14030 AT clio DOT rice DOT edu>
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

> From: sandmann AT clio DOT rice DOT edu (Charles Sandmann)
> Date: Mon, 13 Aug 2001 10:04:10 -0500 (CDT)
>
> > >   #include <crt0.h>
> > >   
> > > !   for(i=0; i<256; i++) {
> > > !     int h, a, s;
> > > !     h = __djgpp_memory_handle_list[i].handle;
> > > !     a = __djgpp_memory_handle_list[i].address;
> > > !     s = __djgpp_memory_handle_size[i];    
> > > !     if(a == 0 && i != 0) break;
> > > !     printf("handle[%d]=0x%x base=0x%x size=0x%x\n",i,h,a,s);
> > > !   }
> > >   @end example
> > 
> > This is an example of usage, not of declaration.  Examples of usage
> > should go into the "Example" section, not into the "Syntax" section.
> 
> Isn't this an example section?

No.  @example is a directive which tells Texinfo (and eventually tells
TeX) to typeset the enclosed block in typewriter font, suitable for
code samples, and also to stop filling the lines.  In other words,
it's the same as the <pre>...</pre> block in HTML.  It does NOT say
that this is an example; in fact the @example part disappears from the
output entirely.

> I thought I was fixing a declaration to be a real example ...

We put usage examples in the Example section.  If there's no such
section, just add it.

I suggest to look at existing *.txh files for inspiration.