Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Nick Bull <nicholaspbull@gmail.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [PATCH v3] Events when inferior is modified
Date: Tue, 31 Dec 2013 16:51:00 -0000	[thread overview]
Message-ID: <83mwjhynei.fsf@gnu.org> (raw)
In-Reply-To: <52C2F2C0.3010201@gmail.com>

> 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.


  reply	other threads:[~2013-12-31 16:51 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-12-31 16:37 Nick Bull
2013-12-31 16:51 ` Eli Zaretskii [this message]
2014-01-03  9:11 ` Phil Muldoon
2014-01-06 12:41   ` [PATCH v4] " Nick Bull
2014-01-06 15:48     ` Eli Zaretskii
2014-01-08 11:36     ` Nick Bull

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83mwjhynei.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=nicholaspbull@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox