From mboxrd@z Thu Jan  1 00:00:00 1970
From: Eli Zaretskii <eliz@delorie.com>
To: jtc@redback.com
Cc: gdb@sourceware.cygnus.com
Subject: Re: memory region documentation
Date: Wed, 15 Nov 2000 03:26:00 -0000
Message-id: <200011151126.GAA03721@indy.delorie.com>
References: <5mg0ku2r9l.fsf@jtc.redback.com>
X-SW-Source: 2000-11/msg00160.html

> From: jtc@redback.com (J.T. Conklin)
> Date: 14 Nov 2000 13:11:18 -0800
> 
> It occured to me that the memory region code can't be considered ready
> until it is documented (at least by my standards, while writing this I
> found that the dcache wasn't documented and it's been in practically 
> forever).  
> 
> I spent some time writing this.

Thanks!

> @node Memory Region Attributes
> @chapter Memory Region Attributes

It is usually a good idea to have a @cindex entry identical to
the chapter/section names; in this case, "@cindex memory region
attributes" (note the all-lower case: it's intentional).

> Memory region attributes allow you to describe special handling required
> by regions of your target's memory.  @value{GDBN} uses attributes to

When introducing a new term, it is usually best to have it in the
@dfn{} markup, when you first use the term:

  @dfn{Memory region attributes} allow you to describe special...

> @subsection Memory Access Mode 
[...]
> @subsection Memory Access Size
[...]
> @subsection Data Cache

Here, too, I'd suggest @cindex entries.