This is the mail archive of the gdb-patches@sources.redhat.com mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: add set cp-abi command



On Tuesday, April 9, 2002, at 11:31  PM, Eli Zaretskii wrote:

>
> On Tue, 9 Apr 2002, Jim Ingham wrote:
>
>> I got distracted from this for a little while...  Here is a final
>> version with something in the texi file as well.
>
> Thanks.  Some comments about the doco patch:
>
>> + @kindex set cp-abi
>> + @item set cp-abi
>> + @itemx set cp-abi auto
>> + Set the C++ ABI that gdb will use to decode C++ objects.  The 
>> default is "auto"
>> + which means gdb will assume the gnu-v2 ABI unless it sees symbols 
>> that
>> + look like the gnu-v3 ABI, in which case it will switch to the gnu-v3 
>> ABI.  With
>> + no arguments, list the available C++ ABIs.
>
> Please explain in a few words what "ABI" means; I don't think Joe Random
> C++ User will necessarily know that.  A list of possible values one can
> use (in addition to "auto") is also something the manual should have.

I not sure I agree with this.  First off, this "set" section doesn't 
explain what other similarly obscure terms mean (like "set vtable").  
These are expert features, so if you need them presumably you know what 
they are.  Also, the available types are dynamically generated.  The 
doc's tell you how to get the list, so it seems like actually listing 
the current possible values is just asking for the manual to get out of 
date...

>
> (Btw, I think that the built-in documentation of the "set abi" command
> could also use a word of explanation of the term "ABI".)
>
> Please change "auto" to ``auto'' (this looks much prettier in the 
> printed
> version, and is translated into "auto" in the Info output), and please
> use C@t{++} instead of C++ (also for aesthetic reasons).
>
> Finally, we use `@value{GDBN}' instead of just `gdb' throughout the
> manual (evidently to allow custom versions of manuals for GDB that is
> named differently).

Will do.

Jim
--
Jim Ingham                                   jingham@apple.com
Developer Tools - gdb
Apple Computer


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]