Re: [PATCH] 2.5 Documentation/CodingStyle ANSI C function declarations.

[Steven Cole <elenstev@mesatop.com>]

On Fri, 2003-05-30 at 15:17, Linus Torvalds wrote:
> On Fri, 30 May 2003, Russell King wrote:
> >
> > On Fri, May 30, 2003 at 01:57:13PM -0600, Steven Cole wrote:
> > > +int foo(
> > > +	long bar,
> > > +	long day,
> > > +	struct magic *xyzzy
> > > +)
> > 
> > Is this really part of the kernel coding style?
> 
> No, but it's better than what it used to be.
> 
> Also, while I don't think we should try to maintain 1:1 behaviour with 
> the _worst_ offenses of zlib, I do think we should maintain comments etc, 
> and a lot of the zlib function declarations used to look like
> 
> 	int foo(bar, baz)
> 	long bar;		/* number of frobnicators */
> 	long baz;		/* self-larting on or off */
> 	{
> 		....
> 
> and the ANSI-fication changes this to
> 
> 	int foo(
> 		long bar,	/* number of frobnicators */
> 		long baz	/* self-larting on or off */
> 	)
> 	{
> 		...
> 
> which while not according to the coding-standard is at least a reasonable 
> compromize between having proper C function definitions and keeping the 
> code _looking_ more like the original.
> 
> 		Linus
> 
> 
OK, here is a modified version of the patch to CodingStyle which
explicitly notes the reason for this secondary style.

Steven

--- linux/Documentation/CodingStyle.orig	2003-05-30 18:41:05.000000000 -0600
+++ linux/Documentation/CodingStyle	2003-05-30 18:46:08.000000000 -0600
@@ -149,6 +149,23 @@
 and it gets confused.  You know you're brilliant, but maybe you'd like
 to understand what you did 2 weeks from now. 
 
+Function declarations should be new-style:
+
+int foo(long bar, long baz, struct magic *xyzzy)
+
+or when replacing old-style declarations which have comments:
+
+int foo(
+	long bar,
+	long baz,
+	struct magic *xyzzy	/* essential comment */
+)
+
+Old-style function declarations are deprecated:
+
+int foo(bar, baz, xyzzy)
+long bar, baz;
+struct magic *xyzzy;		/* essential comment */
 
 		Chapter 5: Commenting