From mboxrd@z Thu Jan 1 00:00:00 1970 From: jtc@redback.com (J.T. Conklin) To: Eli Zaretskii Cc: gdb@sourceware.cygnus.com Subject: Re: memory region documentation Date: Thu, 16 Nov 2000 11:05:00 -0000 Message-id: <5mpujvhh52.fsf@jtc.redback.com> References: <5mg0ku2r9l.fsf@jtc.redback.com> <200011151126.GAA03721@indy.delorie.com> X-SW-Source: 2000-11/msg00190.html >>>>> "Eli" == Eli Zaretskii writes: >> I spent some time writing this. Eli> Thanks! No problem. However, this exercise has reminded me why I'm a programmer and not a tech writer. >> @node Memory Region Attributes >> @chapter Memory Region Attributes Eli> It is usually a good idea to have a @cindex entry identical to Eli> the chapter/section names; in this case, "@cindex memory region Eli> attributes" (note the all-lower case: it's intentional). Done. >> Memory region attributes allow you to describe special handling required >> by regions of your target's memory. @value{GDBN} uses attributes to Eli> When introducing a new term, it is usually best to have it in the Eli> @dfn{} markup, when you first use the term: Done. >> @subsection Memory Access Mode >> [...] >> @subsection Memory Access Size >> [...] >> @subsection Data Cache Eli> Here, too, I'd suggest @cindex entries. This seems a bit odd to me. These are pretty generic concepts. If I was browsing the index I'm not sure I'd expect that they'd be related to memory regions. On the other hand, if I wanted to set the memory access width, it would take me to the right page. Let me know what you think, I'll do whatever you feel is correct. Can you tell me where you'd like me to put this chapter? I assume it's a chapter, since it doesn't seem to be a good fit into any of the existing chapters --- especially if we start adding more varied attributes. Many thanks, --jtc -- J.T. Conklin RedBack Networks