<div dir="ltr">I say let's stick with the Linux kernel style, this makes it easier to use the tools. <div><br></div><div>And being a much bigger and much more mature codebase, kernel is not a bad example to follow in general.<div><br></div><div>--vb</div></div></div><div class="gmail_extra"><br><div class="gmail_quote">On Wed, Aug 24, 2016 at 12:08 AM, Paul Menzel via coreboot <span dir="ltr"><<a href="mailto:coreboot@coreboot.org" target="_blank">coreboot@coreboot.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Dear coreboot folks,<br>
<br>
<br>
The coding style currently demands the following style of multi-line<br>
comments [1].<br>
<br>
> The preferred style for long (multi-line) comments is:<br>
<br>
<br>
        /*<br>
         * This is the preferred style for multi-line<br>
         * comments in the Linux kernel source code.<br>
         * Please use it consistently.<br>
         *<br>
         * Description:  A column of asterisks on the left side,<br>
         * with beginning and ending almost-blank lines.<br>
         */<br>
<br>
This is straight from the Linux Kernel coding style [2].<br>
<br>
Certain parts of the code do not follow this style, so the question is<br>
how to deal with this. There has been some discussion on Gerrit about<br>
that [3]. But the list is the forum for such discussions, so I am<br>
bringing it up here.<br>
<br>
Julius’ last comment:<br>
<br>
> No offense, but that part of the Wiki literally reads:<br>
><br>
> > For files in net/ and drivers/net/ the preferred style for long<br>
> > (multi-line) comments is a little different.<br>
><br>
> ...so I'm not really sure why we should take something that has<br>
> obviously been carelessly bulk-copy&pasted into there from Linux<br>
> kernel sources eons ago as more authoritative than living development<br>
> practice of the last few years.<br>
><br>
> The coreboot wiki is, sorry I have to say it, for the most part<br>
> pretty awful and outdated. It would probably be a good thing to fix<br>
> if somebody has the time for it, but until then I don't think we<br>
> should put too much stake into it (at least in the stuff that hasn't<br>
> been updated and maintained recently).<br>
<br>
I think that the extra blank lines in multi-line comments make them<br>
stand out better, which I prefer over having more lines on the screen.<br>
<br>
Also staying close to the Linux Kernel coding style makes it easier to<br>
use their tools, and not having to adapt them, and people only have to<br>
remember one style.<br>
<br>
But in the end it’s a matter of taste.<br>
<br>
So what should be done? Adapt the coreboot coding syle, or gradually<br>
change the style in the existing code, but require the style in new<br>
commits?<br>
<br>
<br>
Thanks,<br>
<br>
Paul<br>
<br>
<br>
[1] <a href="https://www.coreboot.org/Coding_Style#Commenting" rel="noreferrer" target="_blank">https://www.coreboot.org/<wbr>Coding_Style#Commenting</a><br>
[2] <a href="https://www.kernel.org/doc/Documentation/CodingStyle" rel="noreferrer" target="_blank">https://www.kernel.org/<wbr>doc/Documentation/CodingStyle</a><br>
[3] <a href="https://review.coreboot.org/16060" rel="noreferrer" target="_blank">https://review.coreboot.<wbr>org/16060</a><br>--<br>
coreboot mailing list: <a href="mailto:coreboot@coreboot.org">coreboot@coreboot.org</a><br>
<a href="https://www.coreboot.org/mailman/listinfo/coreboot" rel="noreferrer" target="_blank">https://www.coreboot.org/<wbr>mailman/listinfo/coreboot</a><br></blockquote></div><br></div>