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 v3] Events when inferior is modified


> Date: Tue, 31 Dec 2013 16:37:20 +0000
> From: Nick Bull <nicholaspbull@gmail.com>
> 
> Ping again. At Joels suggestion I have added descriptions to the new
> non-static functions - this brings the commenting in line with current
> practice in Python event code, as far as I can see.

Thanks.

> +@item memory_changed
> +Emits @code{gdb.MemoryChangedEvent} which indicates that the memory of the
> +inferior has been modified by the GDB user, for instance via a command like
                                     ^^^
@value{GDBN}

> +@code{set *addr = value}.  The event has the following attributes:
   ^^^^^^^^^^^^^^^^^^^^^^^^
Suggest to put this in @w{..}, to prevent it from being broken between
2 lines.

> +@defvar MemoryChangedEvent.address
> +The start address of the changed region.
> +@end defvar
> +@defvar MemoryChangedEvent.length
> +Length in bytes of the changed region.
> +@end defvar

Please insert an empty line between the 2 defvar's.

> +@item register_changed
> +Emits @code{gdb.RegisterChangedEvent} which indicates that a register in the
> +inferior has been modified by the GDB user.
                                     ^^^
@value{GDBN}

> +@defvar RegisterChangedEvent.frame
> +A gdb.Frame object representing the frame in which the register was modified.
> +@end defvar
> +@defvar RegisterChangedEvent.regnum
> +Denotes which register was modified.
> +@end defvar

An empty line between defvar's.

The documentation part is OK with those changes and with suitable
doc/ChangeLog entries.


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