|
|
|
|
|
|
|
|
|
|
xen-devel
[Xen-devel] Re: [PATCH] mm: fix comment formatting in asm-generic/pgtabl
To: |
Rusty Russell <rusty@xxxxxxxxxxxxxxx> |
Subject: |
[Xen-devel] Re: [PATCH] mm: fix comment formatting in asm-generic/pgtable.h:__ptep_modify_prot_ |
From: |
Ingo Molnar <mingo@xxxxxxx> |
Date: |
Fri, 13 Jun 2008 09:18:00 +0200 |
Cc: |
Zachary Amsden <zach@xxxxxxxxxx>, Jeremy Fitzhardinge <jeremy@xxxxxxxx>, xen-devel <xen-devel@xxxxxxxxxxxxxxxxxxx>, Peter Zijlstra <a.p.zijlstra@xxxxxxxxx>, kvm-devel <kvm-devel@xxxxxxxxxxxxxxxxxxxxx>, x86@xxxxxxxxxx, LKML <linux-kernel@xxxxxxxxxxxxxxx>, Virtualization Mailing List <virtualization@xxxxxxxxxxxxxx>, Hugh Dickins <hugh@xxxxxxxxxxx>, Thomas Gleixner <tglx@xxxxxxxxxxxxx>, Linus Torvalds <torvalds@xxxxxxxxxxxxxxxxxxxx> |
Delivery-date: |
Fri, 13 Jun 2008 00:18:59 -0700 |
Envelope-to: |
www-data@xxxxxxxxxxxxxxxxxx |
In-reply-to: |
<200806030946.00434.rusty@xxxxxxxxxxxxxxx> |
List-help: |
<mailto:xen-devel-request@lists.xensource.com?subject=help> |
List-id: |
Xen developer discussion <xen-devel.lists.xensource.com> |
List-post: |
<mailto:xen-devel@lists.xensource.com> |
List-subscribe: |
<http://lists.xensource.com/cgi-bin/mailman/listinfo/xen-devel>, <mailto:xen-devel-request@lists.xensource.com?subject=subscribe> |
List-unsubscribe: |
<http://lists.xensource.com/cgi-bin/mailman/listinfo/xen-devel>, <mailto:xen-devel-request@lists.xensource.com?subject=unsubscribe> |
References: |
<patchbomb.1212192268@localhost> <20080602111339.GB18586@xxxxxxx> <4843EF6A.20305@xxxxxxxx> <200806030946.00434.rusty@xxxxxxxxxxxxxxx> |
Sender: |
xen-devel-bounces@xxxxxxxxxxxxxxxxxxx |
User-agent: |
Mutt/1.5.18 (2008-05-17) |
* Rusty Russell <rusty@xxxxxxxxxxxxxxx> 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
_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-devel
|
|
|
|
|