Re: [PATCH] target attributes [5/5] doc

[Hui Zhu <hui_zhu at mentor dot com>]

On 10/26/12 01:31, Eli Zaretskii wrote:
> > From: Hui Zhu <teawater@gmail.com>
> > Date: Sun, 2 Sep 2012 19:20:01 +0800
> > Cc: Hui Zhu <hui_zhu@mentor.com>, gdb-patches@sourceware.org, stan_shebs@mentor.com
> >
> > Oops.  I am so sorry that I post a old version of this patch.  So
> > sorry about that.
> > The attachment is the right version.  Please help me with it.
>
> Sorry for the long delay.
>
> > +@kindex maint load-target-attributes
> > +@item maint load-target-attributes @var{filename}
> > +Load @ref{Target Attributes} from an XML file.
>
> Please don't let @ref serve double duty, it looks ugly in the manual.
> Something like this is better:
>
>    Load target attributes (@pxref{Target Attributes}) from an XML file.
>
> > +@kindex maint clear-target-attributes
> > +@item maint clear-target-attributes
> > +Remove all @ref{Target Attributes}.
>
> Same here.
>
> > +@smallexample
> > +<target-attributes>
> > +	<target-attribute name="foo" id="1" type="int8" >
> > +		<access>
> > +			<agent read="yes" write="no"/>
> > +			<gdb write="yes" read="yes"/>
> > +		</access>
> > +		<support software-breakpoint="yes" hardware-breakpoint="yes" hardware-watchpoint="yes" tracepoint="yes"/>
> > +		<addresses>
> > +			<address start="0x123" end="0x456" />
> > +			<address start="0x789" end="0x1111" />
> > +		</addresses>
> > +	</target-attribute>
> > +	<target-attribute name="bar" id="2" type="int32" target-only-cond-check="yes">
> > +		<access>
> > +			<agent read="yes" write="no"/>
> > +			<gdb read="yes"/>
> > +		</access>
> > +		<support software-breakpoint="yes" hardware-breakpoint="yes" tracepoint="yes"/>
> > +	</target-attribute>
> > +</target-attributes>
> > +@end smallexample
>
> A few lines in this @smallexample will overflow the page dimensions;
> please break them in two lines.
>
> > +If @samp{target-only-cond-check} set to @samp{yes}, GDB will not check the
>                                                         ^^^
> @value{GDBN}
>
> > +condition of breakpoint in its side.  If @samp{target-only-cond-check} not
> > +define, it means @samp{no}.
>     ^^^^^^
> "defined"
>
> > +@smallexample
> > +<support software-breakpoint="yes" hardware-breakpoint="yes" hardware-watchpoint="yes" tracepoint="yes"/>
> > +@end smallexample
>
> Too long, please break into 2 lines.
>
> > +This define the breakpoint address range that a target attribute can
>          ^^^^^^
> "defines"
>
> > +be used in the condition or commands of the breakpoints that are
> > +inside this address range.  If address is defined, this target
> > +attribute supports any address. ^^^^^^^^^^^^^^^^^
>
> Did you mean "not defined"?
>
> > +Target attributes may be used in breakpoint conditions and actions,
> > +as well as being included in expressions and print commands.  The
>                ^^^^^
> "be"
>
> > +of all the breakpoints will reset to 0 when the inferior stops and
>                            ^^^^^^^^^^
> "will be reset"
>
> > +@smallexample
> > +(gdb) target remote :1234
> > +Remote debugging using :1234
> > +Reading symbols from /lib64/ld-linux-x86-64.so.2...(no debugging symbols found)...done.
>
> This line is too long, please break it in 2.
>
> OK with these changes.
>
> Thanks.

Thanks for your help.

I post a new version according to your comments.

Best,
Hui

2012-10-31  Hui Zhu  <hui_zhu@mentor.com>
	    Stan Shebs  <stan@codesourcery.com>

	* agentexpr.texi (Bytecode Descriptions): Update "setv" and
	"getv".
	* gdb.texinfo (Maintenance Commands): Add
	"maint load-target-attributes" and "maint clear-target-attributes".
	(General Query Packets): Add "qXfer:target-attributes:read",
	"qTA" and "QTA".
	(Target Attributes): New appendix.

Attachment: target_attribute_doc.txt
Description: Text document