Re: [coreboot] Proposal for new "Commenting" wiki text (was: [RFC] Deciding on style for multi-line comments)

2017-01-28 Thread Nico Huber
Hi folks, sorry to revive this old, stale topic. I got stalled by a request to ensure the comment style with a script. Now, that I had a look at checkpatch.pl, I don't think this could be done easily without risking many false positives. So I'm again asking to commit my proposal below. I've

Re: [coreboot] Proposal for new "Commenting" wiki text (was: [RFC] Deciding on style for multi-line comments)

2016-09-14 Thread Paul Menzel via coreboot
Dear Nico, Thank you for sending the proposal around. What ever is decided on, please make sure it can be automatically checked by the commit hooks, and that the scripts are updated in the repository at the same time the guidelines are changed. Thanks, Paul signature.asc Description: This

Re: [coreboot] Proposal for new "Commenting" wiki text (was: [RFC] Deciding on style for multi-line comments)

2016-09-07 Thread Nico Huber
On 06.09.2016 00:04, Vadim Bendebury wrote: > On Sun, Sep 4, 2016 at 7:42 AM, Nico Huber wrote: > >> Hi folks, >> >> I think we kind of agreed that the wiki text about "Commenting" should >> change. So here is my proposal, feel free to edit, add something or just >> ack or

Re: [coreboot] Proposal for new "Commenting" wiki text (was: [RFC] Deciding on style for multi-line comments)

2016-09-07 Thread Nico Huber
On 04.09.2016 21:36, Martin Roth wrote: > Hey Nico, > Thanks for writing that up and not just letting this drop with no > resolution and action. > > To anyone just coming in on the discussion, here's what we're talking about > changing: > https://www.coreboot.org/Coding_Style#Commenting > > >

Re: [coreboot] Proposal for new "Commenting" wiki text (was: [RFC] Deciding on style for multi-line comments)

2016-09-05 Thread Vadim Bendebury
On Sun, Sep 4, 2016 at 7:42 AM, Nico Huber wrote: > Hi folks, > > I think we kind of agreed that the wiki text about "Commenting" should > change. So here is my proposal, feel free to edit, add something or just > ack or complain about it. > > > == Commenting == > > > > Comments

[coreboot] Proposal for new "Commenting" wiki text (was: [RFC] Deciding on style for multi-line comments)

2016-09-04 Thread Nico Huber
Hi folks, I think we kind of agreed that the wiki text about "Commenting" should change. So here is my proposal, feel free to edit, add something or just ack or complain about it. > == Commenting == > > Comments are good, but there is also a danger of over-commenting. NEVER > try to explain HOW