This is the mail archive of the gdb-patches@sourceware.org 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: Code formatting [Re: [patch] s390*: watchpoints regression [repost]]


> Date: Sun, 18 Dec 2011 18:24:18 +0100
> From: Jan Kratochvil <jan.kratochvil@redhat.com>
> Cc: Mark Kettenis <mark.kettenis@xs4all.nl>, brobecker@adacore.com,
>         gdb-patches@sourceware.org, pedro@codesourcery.com
> 
> You dropped the important part about "still going through the shell", that was
> the surprising fact to note there.
> 
> If you do not drop that shell part of the text the Pedro's text becomes
> shorter, therefore more clear.

Then don't drop it.  I think I dropped it by mistake.  Anyway, it was
just an example of how to reword a comment to avoid the problem that
started this thread.

> Also you just describe 
> 
>   /* This is the main thread still going through the shell, or, no
>      watchpoint has been set yet.  */
> ->
>   /* Nothing else to do if this is the main thread, or if no
>      watchpoints have been set yet.  */
> 
> additionally the "return" clause there.  "return" does not need any comment.

"Nothing else to do" explains _why_ we return, which is the point of
the comment, isn't it?


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