From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-patches-return-98471-listarch-gdb-patches=sources.redhat.com@sourceware.org>
Received: (qmail 14094 invoked by alias); 13 Feb 2013 17:52:55 -0000
Received: (qmail 14083 invoked by uid 22791); 13 Feb 2013 17:52:54 -0000
X-SWARE-Spam-Status: No, hits=-4.6 required=5.0	tests=AWL,BAYES_00,KHOP_THREADED,RCVD_IN_DNSWL_NONE,RCVD_IN_HOSTKARMA_NO,SPF_SOFTFAIL
X-Spam-Check-By: sourceware.org
Received: from mtaout21.012.net.il (HELO mtaout21.012.net.il) (80.179.55.169)    by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Wed, 13 Feb 2013 17:52:47 +0000
Received: from conversion-daemon.a-mtaout21.012.net.il by a-mtaout21.012.net.il (HyperSendmail v2007.08) id <0MI6005006UDL800@a-mtaout21.012.net.il> for gdb-patches@sourceware.org; Wed, 13 Feb 2013 19:52:45 +0200 (IST)
Received: from HOME-C4E4A596F7 ([87.69.4.28]) by a-mtaout21.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0MI6005KF6ZXG950@a-mtaout21.012.net.il>; Wed, 13 Feb 2013 19:52:45 +0200 (IST)
Date: Wed, 13 Feb 2013 17:52:00 -0000
From: Eli Zaretskii <eliz@gnu.org>
Subject: Re: [RFC - Python Scripting] New method gdb.Architecture.disassemble
In-reply-to: <CAGyQ6gzSs617BRcreAGA5418EpXaqCaPN8ZzKjQYNx9yxDSJRA@mail.gmail.com>
To: Siva Chandra <sivachandra@google.com>
Cc: tromey@redhat.com, dje@google.com, gdb-patches@sourceware.org
Reply-to: Eli Zaretskii <eliz@gnu.org>
Message-id: <83ip5w3xtv.fsf@gnu.org>
References: <CAGyQ6gy_08hZn2Pk6pmD+AuOkH7SCsQ6732KTa7sucZ7-4prUA@mail.gmail.com> <20753.38272.55066.651097@ruffy2.mtv.corp.google.com> <CAGyQ6gy68LdCd_qxDX7vinMg-Pb6qnukGScOw2uzgezxKxh_TA@mail.gmail.com> <CADPb22TGJNFg7VJkeoTB7Ctd=K2Tc490LKo_mdUVXFF2K6TV5g@mail.gmail.com> <CAGyQ6gweW=9L4mVCkFetd+LvvpjSYzYKM78mYDu5HfG1LpVwiQ@mail.gmail.com> <87txphmdt3.fsf@fleche.redhat.com> <CAGyQ6gzSs617BRcreAGA5418EpXaqCaPN8ZzKjQYNx9yxDSJRA@mail.gmail.com>
X-IsSubscribed: yes
Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm
Precedence: bulk
List-Id: <gdb-patches.sourceware.org>
List-Subscribe: <mailto:gdb-patches-subscribe@sourceware.org>
List-Archive: <http://sourceware.org/ml/gdb-patches/>
List-Post: <mailto:gdb-patches@sourceware.org>
List-Help: <mailto:gdb-patches-help@sourceware.org>, <http://sourceware.org/ml/#faqs>
Sender: gdb-patches-owner@sourceware.org
X-SW-Source: 2013-02/txt/msg00321.txt.bz2

> Date: Wed, 13 Feb 2013 06:37:46 -0800
> From: Siva Chandra <sivachandra@google.com>
> Cc: Doug Evans <dje@google.com>, gdb-patches <gdb-patches@sourceware.org>
> 
> I have addressed all of Tom's comments and added docs and tests in the
> attached patch. I did not add a NEWS entry as an entry already exists
> for the new gdb.Architecture class.

Thanks.

> +@defun Architecture.disassemble (@var{low}, @var{high})
> +Return a list of disassembled instructions in the memory address range
> +@var{low} to @var{high}.

Please document whether the range is inclusive or exclusive.  Being
in doubt about these nits is one of my big annoyances with
documentation out there.

> +@table @asis

Since all of the @item's use @code, it is better to use

  @table @code

> +@item @code{`addr'}

No need for another pair of quotes inside @code.  (But if you want the
quotes in the printed version of the manual as well, use @samp
instead of @code.

> +@item @code{`asm'}
> +The value corresponding to this key is a string value capturing the
> +assembly language code of the instruction.

What is "assembly language code"? is it a mnemonic instruction name or
a numeric opcode?

Btw, an example would clarify these issues nicely.

OK with those changes.