Messages in this thread | | | Date | Fri, 13 Jun 2008 09:18:00 +0200 | From | Ingo Molnar <> | Subject | Re: [PATCH] mm: fix comment formatting in asm-generic/pgtable.h:__ptep_modify_prot_ |
| |
* Rusty Russell <rusty@rustcorp.com.au> wrote:
> > - /* Get the current pte state, but zero it out to make it > > - non-present, preventing the hardware from asynchronously > > - updating it. */ > > + /* > > + * Get the current pte state, but zero it out to make it > > + * non-present, preventing the hardware from asynchronously > > + * updating it. > > + */ > > Since there is debate over whether winged comments are a feature, I'm > not sure this can be termed a "fix".
Well, if you compare the two variants above Jeremy's solution looks visually more pleasing, so yes it is an improvement and a fix.
( And it's even very obvious in this case, the vertical line gives a clear delineation of the information and separates it from the code sections. )
Also, according to Documentation/CodingStyle:
| The preferred style for long (multi-line) comments is: | | /* | * This is the preferred style for multi-line | * comments in the Linux kernel source code. | * Please use it consistently. | * | * Description: A column of asterisks on the left side, | * with beginning and ending almost-blank lines. | */
arch/x86 and include/asm-x86 follows that rule. (And we'd follow it even if the issue was typographically debatable [which it isnt] because consistency is visual rule #0 )
Ingo
| |