linux-kernel - Re: [PATCH][1/5][resend] floppy.c: Initial (partial) CodingStyle cleanup

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: Windows password security audit tool. GUI, reports in PDF.

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

Date:	Mon, 19 Mar 2007 23:25:08 +0100
From:	"Jesper Juhl" <jesper.juhl@...il.com>
To:	"Adrian Bunk" <bunk@...sta.de>
Cc:	"Randy Dunlap" <randy.dunlap@...cle.com>,
	"Andrew Morton" <akpm@...ux-foundation.org>,
	LKML <linux-kernel@...r.kernel.org>, "Andi Kleen" <ak@...e.de>,
	"Trent Waddington" <trent.waddington@...il.com>,
	"Bartlomiej Zolnierkiewicz" <bzolnier@...il.com>,
	"Alan Cox" <alan@...rguk.ukuu.org.uk>
Subject: Re: [PATCH][1/5][resend] floppy.c: Initial (partial) CodingStyle cleanup

On 19/03/07, Adrian Bunk <bunk@...sta.de> wrote:
> On Mon, Mar 19, 2007 at 07:18:38PM +0100, Jesper Juhl wrote:
> >...
> > The second reason is that indenting two tabs seems to make the most sense for
> > a few reasons;
> >       a) not indenting at all is ugly, plain and simple.
> >               void function(int a, int b,
> >               int c, int d, int e)
> >               {
> >                       int foo;
> >                       int bar;
> >               ...
> >               }
> >       b) indenting only one tab stop puts parameters at the same indent level as
> >          variables in the function which is potentially confusing (at least IMHO).
> >               void function(int a, int b,
> >                       int c, int d, int e)
> >               {
> >                       int foo;
> >                       int bar;
> >               ...
> >               }
> >       c) Indenting so that all parameter lines start at the opening paranthesis
> >          rarely matches up with tabs so you have to use varying amounts of spaces
> >          depending on how long the function name is. Not a good solution IMHO.
> >               void function(int a, int b,
> >                                    int c, int d, int e)
> >...
>
> Your example is wrong, it's:
>
>                void function(int a, int b,
>                              int c, int d, int e)
>
Hmm, thanks, when I wrote it in kmail it looked right. two tabs and
then spaces to make it line up with the starting '('.

>
> This is the most common convention in the kernel - and except for
> extremely long function names it's the one with the best readability.
>
It may be the most common, but I don't agree that it has the best
readability - but I guess that's very much a subjective thing.

> Yes, it's a problem with extremely long function names, but they are
> rare in the kernel.
>
> And the "varying amounts of spaces" should be handled automatically by
> your editor.
>

My editor may handle it initially when writing the code, but then it
gets changed and not updated or spaces and tabs end up getting mixed -
like "<tab><tab><space><tab><space>" or something else - it easily
turns into a mess.

Simply using two tabs makes it easy to see that it's not variables in
the function body and is an easy and simple convention to follow (and
IMHO also very readable).

But I guess we'll have to agree to disagree on this.
In any case, thank you for your input.

-- 
Jesper Juhl <jesper.juhl@...il.com>
Don't top-post  http://www.catb.org/~esr/jargon/html/T/top-post.html
Plain text mails only, please      http://www.expita.com/nomime.html
-
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/