This is the mail archive of the
gdb@sources.redhat.com
mailing list for the GDB project.
Re: memory region documentation
- To: jtc at redback dot com
- Subject: Re: memory region documentation
- From: Eli Zaretskii <eliz at delorie dot com>
- Date: Wed, 15 Nov 2000 06:26:22 -0500 (EST)
- CC: gdb at sourceware dot cygnus dot com
- References: <5mg0ku2r9l.fsf@jtc.redback.com>
- Reply-to: Eli Zaretskii <eliz at is dot elta dot co dot il>
> 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.