This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [RFC - Python Scripting] New method gdb.Architecture.disassemble
> 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.