Re: [PATCH] Support _Complex in hard-VFP abi

Pedro Alves
2014-08-20T08:21:01Z

On 08/20/2014 04:42 AM, Yao Qi wrote:
> On 08/20/2014 06:44 AM, Pedro Alves wrote:
>> This is borderline pedantry, but this looks ugly enough to me that
>> I'll speak up in case this ends up being the norm. :-) FWIW, I agree
>> with Will here -- I think we should make an exception to the rule
>> in the cases where the comment is actually a paste of output,
>> multiline code or similar cases. It's kind of like a @smallexample
>> region in texinfo, that begs to be rendered on its own block/lines,
>> separate from the text around it.
>
> I am fine with this exception here, but we'd better document it.
>
> The rule is documented here
> https://sourceware.org/gdb/wiki/Internals%20GDB-C-Coding-Standards
>
> Block comments must appear in the following form, with no /*- or */-only lines, and no leading *:
>
> /* Wait for control to return from inferior to debugger. If inferior
> gets a signal, we may decide to start it up again instead of
> returning. That is why there is a loop in this function. When
> this function actually returns it means the inferior should be left
> stopped and GDB should read more commands. */
>
> I propose to add the following words after this paragraph above,
>
> "Exceptionally, */ can be put at a separate line if the comment is ended
> with an example, an output or a code snippet:
>
> /* Arguments of complex T where T is one of the types float or
> double get treated as if they are implemented as:
>
> struct complexT
> {
> T real;
> T imag;
> };
>
> */"
>

That's excellent, IMO.

> The patch below updates the comments I've seen in current code base.
>

Looks great to me.

Thanks,
Pedro Alves