Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: dje@google.com (Doug Evans)
Cc: gdb-patches@sourceware.org
Subject: Re: [RFA][python] Add program space support
Date: Wed, 07 Apr 2010 17:52:00 -0000	[thread overview]
Message-ID: <83r5mrw3oz.fsf@gnu.org> (raw)
In-Reply-To: <20100407173222.A21C584397@ruffy.mtv.corp.google.com>

> Date: Wed,  7 Apr 2010 10:32:22 -0700 (PDT)
> From: dje@google.com (Doug Evans)
> 
> This patch adds basic support for program spaces to python.

Thanks.  A few comments to the patch for the manual:

> 	doc/
> 	* gdb.texinfo (Python API): Add progspaces section.
> 	(Selecting Pretty-Printers): Progspace pretty-printers are
> 	searched too.

This lacks an entry for the new section you added.

> +@node Progspaces In Python
> +@subsubsection Progspaces In Python

It is okay to use shorthands in node names, but for the section name
I'd prefer to use "Program Spaces", the full name.  There's no
requirement for the two to be identical.

> +A program space, or ``progspace'', represents a symbolic view
                       ^^^^^^^^^^^^^
Please use @dfn{progspace} here, it is specifically designed for
introducing new terminology.  It produces the same quoted string in
Info as ``..'', but looks prettier in the printed version.

> +A program space, or ``progspace'', represents a symbolic view
> +of an address space.

An @xref here to where program spaces are described would be useful.

> +@findex gdb.current_progspace
> +@defun current_progspace
> +This function returns the program space of the currently selected inferior.

Is this a function or a method?  If the latter, we have @defmethod to
DTRT.

Okay with those changes.

Thanks.


  parent reply	other threads:[~2010-04-07 17:52 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-04-07 17:32 Doug Evans
2010-04-07 17:39 ` Doug Evans
2010-04-07 17:54   ` Eli Zaretskii
2010-04-07 17:52 ` Eli Zaretskii [this message]
2010-04-08 22:24   ` Doug Evans
2010-04-09  7:37     ` Eli Zaretskii
2010-04-09 15:34       ` Doug Evans
2010-04-09 15:42         ` Pedro Alves
2010-04-14 22:47           ` Doug Evans

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=83r5mrw3oz.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=dje@google.com \
    --cc=gdb-patches@sourceware.org \
    /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