public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Alexander Smundak <asmundak@google.com>
Cc: dje@google.com, wingo@igalia.com, gdb-patches@sourceware.org
Subject: Re: [RFC] [PATCH] Provide the ability to write the frame unwinder in Python
Date: Thu, 26 Mar 2015 18:53:00 -0000	[thread overview]
Message-ID: <83mw2zmvzf.fsf@gnu.org> (raw)
In-Reply-To: <CAHQ51u49b6rcb3m7XM=0i=pfdG9A7wKeV8SXPOhpRps=s3-HSg@mail.gmail.com>

> Date: Wed, 25 Mar 2015 20:31:09 -0700
> From: Alexander Smundak <asmundak@google.com>
> Cc: Andy Wingo <wingo@igalia.com>, gdb-patches <gdb-patches@sourceware.org>
> 
> --- a/gdb/NEWS
> +++ b/gdb/NEWS
> @@ -12,6 +12,7 @@
>    ** gdb.Objfile objects have a new attribute "username",
>       which is the name of the objfile as specified by the user,
>       without, for example, resolving symlinks.
> +  ** You can now write frame unwinders in Python.

This part is OK.

> +@node Unwinding Frames in Python
> +@subsubsection Unwinding Frames in Python
> +@cindex Unwinding frames in Python.

@cindex entries should generally begin with a lower-case letter.
That's because alphabetic sorting in various locales might produce
different orders when mixed-case letters are involved, so the order in
the Index nodes will be different depending on where the manual was
produced.  We want to avoid that.

> +In GDB terminology ``unwinding'' is the process of finding the
      ^^^
"@value{GDBN}" (here and elsewhere in the patch).

> +previous frame (that is, caller's) from the current one. An unwinder
                                                          ^^
Two spaces between sentences (here and elsewhere in the patch).

> +(for example, and application running Java Virtual Machine) sometimes
                 ^^^
"an"

> +returns an object (an instance of gdb.UnwindInfo class) describing
                                     ^^^^^^^^^^^^^^
This should be in @code, as it's a Python symbol.

> +usually found in the corresponding xxx-@code{tdep.h} file in the gdb
                                      ^^^^^^^^^^^^^^^^^
It is better to write @file{@var{platform}-tdep.h} here; this explains
better what is that "xxx" in the text.

> +It also provides a factory method to create a gdb.UnwindInfo instance
                                                 ^^^^^^^^^^^^^^
@code

> +using one of the @code{frame_id_build_xxx} functions.  The exact

Once again, please try a way to make "xxx" more clear, as I did above.

Thanks.

  reply	other threads:[~2015-03-26 18:53 UTC|newest]

Thread overview: 60+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-12-15 18:14 Alexander Smundak
2014-12-22 19:24 ` Alexander Smundak
2014-12-29 18:02   ` Alexander Smundak
2015-01-05 17:53     ` Alexander Smundak
2015-01-12 20:03       ` Alexander Smundak
2015-01-22  3:31         ` Alexander Smundak
2015-01-29  1:36           ` Alexander Smundak
2015-01-12 21:00 ` Simon Marchi
2015-01-12 21:22   ` Doug Evans
2015-02-04 22:36 ` Doug Evans
2015-02-12 17:58   ` Alexander Smundak
2015-02-19  2:32     ` Alexander Smundak
2015-02-20 11:12     ` Phil Muldoon
2015-02-26  3:09       ` Alexander Smundak
2015-03-02 22:56         ` Alexander Smundak
2015-03-03  8:46           ` Andy Wingo
2015-03-04  2:36             ` Alexander Smundak
2015-03-04  7:49               ` Andy Wingo
2015-03-09 11:02                 ` Phil Muldoon
2015-03-11  2:22                   ` Alexander Smundak
2015-03-11  8:49                     ` Andy Wingo
2015-03-11 17:34                       ` Doug Evans
2015-03-11 18:48                       ` Alexander Smundak
2015-03-16 11:29                         ` Andy Wingo
2015-03-16 12:01                           ` Andy Wingo
2015-03-16 17:25                           ` Alexander Smundak
2015-03-17  8:57                             ` Andy Wingo
2015-03-17 19:48                               ` Alexander Smundak
2015-03-17 21:37                                 ` Alexander Smundak
2015-03-18  8:54                                   ` Andy Wingo
2015-03-18 22:57                                     ` Alexander Smundak
2015-03-23 19:58                                       ` Doug Evans
2015-03-24  9:06                                         ` Andy Wingo
2015-03-26  3:31                                         ` Alexander Smundak
2015-03-26 18:53                                           ` Eli Zaretskii [this message]
2015-03-27 22:29                                           ` Doug Evans
2015-03-28  1:10                                             ` Alexander Smundak
2015-03-30 17:45                                               ` Doug Evans
2015-03-30 19:49                                                 ` Alexander Smundak
2015-03-31 22:36                                                   ` Doug Evans
2015-04-01  0:09                                                     ` Alexander Smundak
2015-04-01  0:28                                                       ` Doug Evans
2015-03-18 23:25                                 ` Doug Evans
2015-03-19  0:36                                   ` Alexander Smundak
2015-03-19  8:12                                     ` Andy Wingo
2015-03-20  0:15                                       ` Doug Evans
2015-03-20  2:27                                         ` Alexander Smundak
2015-03-20 17:48                                           ` Doug Evans
2015-03-20  8:26                                         ` Andy Wingo
2015-03-20 18:32                                           ` Doug Evans
2015-03-17 22:21                               ` Doug Evans
2015-03-18  8:57                                 ` Andy Wingo
2015-03-18 16:48                                   ` Doug Evans
2015-03-19  8:04                                     ` Andy Wingo
2015-03-09  9:42           ` Andy Wingo
2015-03-03  0:49         ` Alexander Smundak
2015-03-03 14:38           ` Andy Wingo
2015-03-04  2:52             ` Alexander Smundak
2015-02-20  9:42 ` Phil Muldoon
2015-02-20  9:59   ` Phil Muldoon

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=83mw2zmvzf.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=asmundak@google.com \
    --cc=dje@google.com \
    --cc=gdb-patches@sourceware.org \
    --cc=wingo@igalia.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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).