[llvm] r189704 - Remove the suggestion to not duplicate comments in header and

[Dmitri Gribenko]

On Sat, Aug 31, 2013 at 9:12 AM, David Blaikie <dblaikie at gmail.com> wrote:
>
> On Aug 30, 2013 5:55 PM, "Chris Lattner" <clattner at apple.com> wrote:
>>
>>
>> On Aug 30, 2013, at 4:41 PM, David Blaikie <dblaikie at gmail.com> wrote:
>>
>> > On Fri, Aug 30, 2013 at 4:34 PM, Chris Lattner <clattner at apple.com>
>> > wrote:
>> >> On Aug 30, 2013, at 4:24 PM, Benjamin Kramer <benny.kra at gmail.com>
>> >> wrote:
>> >>> On 31.08.2013, at 01:06, Chris Lattner <sabre at nondot.org> wrote:
>> >>>
>> >>>> Author: lattner
>> >>>> Date: Fri Aug 30 18:06:20 2013
>> >>>> New Revision: 189704
>> >>>>
>> >>>> URL: http://llvm.org/viewvc/llvm-project?rev=189704&view=rev
>> >>>> Log:
>> >>>> Remove the suggestion to not duplicate comments in header and
>> >>>> implementation files.  While doc generation systems don't need this,
>> >>>> humans do benefit from it.  Not everyone reads all code through
>> >>>> doxygen.
>> >>>
>> >>> I disagree.
>> >>
>> >> I expected this to start a discussion… this is good because the
>> >> discussion never happened when gribozavr "Document current Doxygen use
>> >> practices in Coding Standards" in r166378.
>> >
>> > Actually it did:
>> >
>> > http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20120910/150633.html
>>
>> Ok, it looks like all the discussion was in favor of this never being
>> added to CodingStandards :-)

Not at all.  The discussion was long, and not all messages are
accessible from the link above.  Here's the next part:

http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20120917/151393.html

> Not quite sure where you got that idea, though I'll admit the web archive
> isn't the best ui for reading things (but easiest way to reference it,
> searching your own email archive tends to be the more effective way to read
> the whole thread)
>
> Andrew conceded to the patch later in the thread and eventually chandler
> signed off on it.

Indeed.  Seems the discussion was long held for longer than one week,
so later messages can not be reached from the link posted above.
Here's the sign-off message:

http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20121015/153895.html

> This patch was appropriately pre-commit reviewed with discussion and
> disagreement, reverting/undoing it outright seems somewhat poor form.
>
> (Not to say that there's no room for further discussion, and I realize,
> while Dmitry mentioned you in the email, he didn't actually cc you, so it
> can be easy for things to get lost in the masses of email)

I did CC Chris.  From my mailbox:

Message-ID: <CA+Y5xYcbeOGnB+hWUwNLhDc8D6PHfD4ik6auJ=hZSq92SYaS1g at mail.gmail.com>
Subject: [PATCH] Coding Standards: Doxygen guidelines
From: Dmitri Gribenko <gribozavr at gmail.com>
To: llvm-commits at cs.uiuc.edu
Cc: Sean Silva <silvas at purdue.edu>, Chris Lattner <clattner at apple.com>,
Chandler Carruth <chandlerc at google.com>

Maybe the mailing list software stripped CC headers in copies sent to
other subscribers.

Dmitri

-- 
main(i,j){for(i=2;;i++){for(j=2;j<i;j++){if(!(i%j)){j=0;break;}}if
(j){printf("%d\n",i);}}} /*Dmitri Gribenko <gribozavr at gmail.com>*/