Re: [rfc / remote protocol] Remote shared library events

[Daniel Jacobowitz <drow at false dot org>]

On Thu, May 10, 2007 at 06:18:29AM +0300, Eli Zaretskii wrote:
> > +@item
> > +If @var{n} is @samp{load}, then the packet indicates a DLL load event,
> > +and @var{r} describes the newly loaded library.  The library format is
> > +the same used in @samp{qfDllInfo} replies (@pxref{qfDllInfo}), e.g.@:
> > +@samp{load:Name=@var{hexname},TextSeg=@var{textaddr}}.  The entry may
> > +end in @samp{,nop} if this library was already mapped, e.g.@: by an
> > +earlier call to @code{LoadLibrary}.  @var{aa} should be @samp{05}, the
> > +trap signal.
> 
> I think we need to explain what is ``hexname'' here, unless it is
> already used and explained in the preceding portion of this section.

It's explained at the target of the @pxref, where TextSeg and textaddr
are also; is that OK?

> Also, should we have some index entries here?

Yep.

> > +until the target responds with @samp{l} (lower-case el, for
>                                                        ^^
> I believe the letter's name is ``ell''.

"In reference, it is spelled el or ell." says Wikipedia; I actually
copied this from a few lines further down in the manual.  If there's
some reason to change el -> ell let me know and I'll do it consistently.

> > +Reply:
> > +@table @samp
> > +@item m Name=@var{hexname},TextSeg=@var{textaddr}@r{[},DataSeg=@var{dataaddr}@r{]}
> 
> Does this long line look good in print?

Yes, it seems to be OK; it's less than half the print area wide in the PDF.

> > +@item m @var{library}; @var{library}@dots{} @r{[}; l@r{[}
> 
> Did you really mean two left [ brackets here?

Whoops!  I'll have updated documentation in the revised patch, due soon.

-- 
Daniel Jacobowitz
CodeSourcery