Keith Seitz | 16 Aug 2012 22:15
Picon
Favicon

[RFA 3/3] c++/13356: Update documentation

Hi,

So this is the final patch which deals with a pretty major documentation 
overhaul regarding the never-implemented-and-probably-never-will-be 
"type checker."

The patch basically removes all references to "type checker," updates 
the documentation for "check type", and replaces some outdated Modula-2 
references/example. I've taken the opportunity to correct a few run-on 
sentences as well.

Keith

doc/ChangeLog
2012-08-16  Keith Seitz  <keiths <at> redhat.com>

	PR c++/13356
	* gdb.texinfo (Type and Range Checking): Remove warning.
	Remove spurious commas.
	Update text and examples for re-implementation of set/show
	check type.
	(C and C++ Type and Range Checks): Likewise.

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 7dee642..56e3108 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
 <at>  <at>  -12670,29 +12670,18  <at>  <at>  List all the filename extensions and the 
associated languages.
   <at> node Checks
(Continue reading)

Eli Zaretskii | 16 Aug 2012 22:44
Picon

Re: [RFA 3/3] c++/13356: Update documentation

> Date: Thu, 16 Aug 2012 13:15:53 -0700
> From: Keith Seitz <keiths <at> redhat.com>
> 
> +The second example fails because the integer constant  <at> samp{0x1234} is not
> +type-compatible with the pointer parameter type.

Why not? if the current language is C, I see no incompatibilities
here.  What am I missing?

> +When type checking is disabled,  <at> value{GDBN} evaluates expressions
> +like the second example above.

Should probably say "successfully evaluates".

> +Set strict type checking on or off. If any type mismatches occur in
                                     ^^
Two spaces, please.

OK with those changes.

Thanks.

Keith Seitz | 16 Aug 2012 22:51
Picon
Favicon

Re: [RFA 3/3] c++/13356: Update documentation

On 08/16/2012 01:44 PM, Eli Zaretskii wrote:
>> Date: Thu, 16 Aug 2012 13:15:53 -0700
>> From: Keith Seitz <keiths <at> redhat.com>
>>
>> +The second example fails because the integer constant  <at> samp{0x1234} is not
>> +type-compatible with the pointer parameter type.
>
> Why not? if the current language is C, I see no incompatibilities
> here.  What am I missing?

That conversion is forbidden by C++. Perhaps I should have used a method 
call instead to make that more obvious?

>> +When type checking is disabled,  <at> value{GDBN} evaluates expressions
>> +like the second example above.
>
> Should probably say "successfully evaluates".
>

Changed.

>> +Set strict type checking on or off. If any type mismatches occur in
>                                       ^^
> Two spaces, please.

Zoiks! Changed.

> OK with those changes.

Thank you!
(Continue reading)

Eli Zaretskii | 17 Aug 2012 08:19
Picon

Re: [RFA 3/3] c++/13356: Update documentation

> Date: Thu, 16 Aug 2012 13:51:06 -0700
> From: Keith Seitz <keiths <at> redhat.com>
> CC: gdb-patches <at> sourceware.org
> 
> On 08/16/2012 01:44 PM, Eli Zaretskii wrote:
> >> Date: Thu, 16 Aug 2012 13:15:53 -0700
> >> From: Keith Seitz <keiths <at> redhat.com>
> >>
> >> +The second example fails because the integer constant  <at> samp{0x1234} is not
> >> +type-compatible with the pointer parameter type.
> >
> > Why not? if the current language is C, I see no incompatibilities
> > here.  What am I missing?
> 
> That conversion is forbidden by C++. Perhaps I should have used a method 
> call instead to make that more obvious?

Yes, that would be good.  And/or explicitly tell that C++ forbids
that.

Thanks.

Pedro Alves | 23 Aug 2012 20:51
Picon
Favicon

Re: [RFA 3/3] c++/13356: Update documentation

IMO, this is NEWS worthy, given there's a user visible knob involved.

--

-- 
Pedro Alves


Gmane