This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: PATCH: Document i386 target features


> Date: Mon, 8 Feb 2010 07:33:37 -0800
> From: "H.J. Lu" <hongjiu.lu@intel.com>
> 
> Here is the patch to document i386 target features for i386 XML files
> I checked in.  OK to install?

Thanks, I have a few comments:

> +@cindex target descriptions, I386 features

Index entries are supposed to be mostly in lower case.  Would it be
okay to use "i386" instead of I386 here?

> +targets.  It should contain registers @samp{eax} through @samp{edi}
> +plus @samp{eip} for i386 and @samp{rax} through @samp{r15} plus
> +@samp{rip} for amd64, @samp{eflags}, @samp{cs}, @samp{ss}, @samp{ds},
> +@samp{es}, @samp{fs}, @samp{gs}, registers @samp{st0} through @samp{st7},
> +@samp{fctrl}, @samp{fstat}, @samp{ftag}, @samp{fiseg}, @samp{fioff},
> +@samp{foseg}, @samp{fooff} and @samp{fop}.

This list is very long, and makes the sentence long and hard to
grasp.  I think it would be more palatable as an itemized list, like
so:

 It should contain the following registers:

 @itemize @minus
 @item
 @samp{eax} through @samp{edi} and @samp{eip} for i386
 @item
 @samp{rax} through @samp{r15} plus @samp{rip} for amd64
 @item
 @samp{eflags}
 @item
 @samp{cs}, @samp{ss}, @samp{ds}, @samp{es}, @samp{fs}, @samp{gs}
 ...
 @end itemize

(I grouped related registers together to make the list shorter).

Btw, is it "contain the following registers" or "describe the
following registers"? 

> +They may be i386 or amd64 depending on the target.

Who are "they" here?


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]