linux-kernel - Re: [PATCH] mm: fix comment formatting in asm-generic/pgtable.h:__ptep_modify_prot

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20080613071800.GA11976@elte.hu>
Date:	Fri, 13 Jun 2008 09:18:00 +0200
From:	Ingo Molnar <mingo@...e.hu>
To:	Rusty Russell <rusty@...tcorp.com.au>
Cc:	Jeremy Fitzhardinge <jeremy@...p.org>,
	LKML <linux-kernel@...r.kernel.org>, x86@...nel.org,
	xen-devel <xen-devel@...ts.xensource.com>,
	Thomas Gleixner <tglx@...utronix.de>,
	Hugh Dickins <hugh@...itas.com>,
	Zachary Amsden <zach@...are.com>,
	kvm-devel <kvm-devel@...ts.sourceforge.net>,
	Virtualization Mailing List <virtualization@...ts.osdl.org>,
	Peter Zijlstra <a.p.zijlstra@...llo.nl>,
	Linus Torvalds <torvalds@...ux-foundation.org>
Subject: Re: [PATCH] mm: fix comment formatting in
	asm-generic/pgtable.h:__ptep_modify_prot_


* Rusty Russell <rusty@...tcorp.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
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/