Re: [PATCH] microMIPS support

[Eli Zaretskii <eliz@gnu.org>]

> Date: Tue, 24 Apr 2012 21:29:01 +0100
> From: "Maciej W. Rozycki" <macro@codesourcery.com>
> 
>  Here's a change that adds support for debugging binaries containing 
> microMIPS code.  There's not much to say about it except that it works. ;)  

Thanks.

> +@item set mips compression @var{arg}
> +@kindex set mips compression
> +@cindex MIPS code compression

Please use lower-case "mips" in the @cindex entry as well.

> +Tell @value{GDBN} which MIPS compressed ISA encoding is used by the
> +inferior.  @value{GDBN} uses this for code disassembly and other
> +internal interpretation purposes.  This setting is only referred to
> +when no executable has been associated with the debugging session or
> +the executable does not provide information about the encoding it uses.
> +Otherwise this setting is automatically updated from information
> +provided by the executable.
> +
> +Possible values of @var{arg} are @samp{mips16} and @samp{micromips}.
> +The default compressed ISA encoding is @samp{mips16}, as executables
> +containing MIPS16 code frequently are not identified as such.
> +
> +This setting is ``sticky''; that is, it retains its value across
> +debugging sessions until reset either explicitly with this command or
> +implicitly from an executable.
> +
> +The compiler and/or assembler typically add symbol table annotations to
> +identify functions compiled for the MIPS16 or microMIPS ISAs.  If these
> +function-scope annotations are present, @value{GDBN} uses them in
> +preference to the global compressed ISA encoding setting.

I would suggest to use either @acronym{ISA} or @sc{isa} (and the same
with "MIPS16" and "MIPS"), since they will look better in print.  Try
both, produce the PDF version of the manual, and keep the one you like
best.

> +@subsubsection Breakpoint Kinds
> +
> +These breakpoint kinds are defined for the @samp{Z0} and @samp{Z1} packets.

I'd prefer to have a @node here; subsections without a node are
possible, but are harder to find.

Also, a @cindex entry here would be good; think about someone who'd
like to find this information quickly by searching the index.

OK with those changes.

> +  add_setshow_enum_cmd ("compression", class_obscure, mips_compression_strings,
> +			&mips_compression_string, _("\
> +Set the compressed ISA encoding used."), _("\
> +Show the compressed ISA encoding used."), _("\

I'd mention microMIPS in the doc strings, as in

 Set the compressed ISA encoding used by microMIPS binaries.

> Index: gdb-fsf-trunk-quilt/gdb/NEWS
> ===================================================================
> --- gdb-fsf-trunk-quilt.orig/gdb/NEWS	2012-04-24 20:57:21.000000000 +0100
> +++ gdb-fsf-trunk-quilt/gdb/NEWS	2012-04-24 20:58:23.645567943 +0100
> @@ -3,6 +3,8 @@
>  
>  *** Changes since GDB 7.4
>  
> +* GDB now supports debugging microMIPS binaries.
> +
>  * GDB now supports reversible debugging on ARM, it allows you to
>    debug basic ARM and THUMB instructions, and provides 
>    record/replay support.  
> @@ -124,6 +126,14 @@ HP OpenVMS ia64			ia64-hp-openvms*
>  
>  * New options
>  
> +set mips compression
> +show mips compression
> +  Select the compressed ISA encoding used in functions that have no symbol
> +  information available.  The encoding can be set to either of:
> +    mips16
> +    micromips
> +  and is updated automatically from ELF file flags if available.
> +

This is OK.