Messages in this thread Patch in this message | | | Subject | Re: [PATCH] 2.5 Documentation/CodingStyle ANSI C function declarations. | From | Steven Cole <> | Date | 30 May 2003 23:08:05 -0600 |
| |
On Fri, 2003-05-30 at 21:12, Arnaldo Carvalho de Melo wrote: [snippage] > > > 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. > > In the cases where there are documentation for the paramenters isn't it better > to just bite the bullet and use the kerneldoc style? > > Documentation/kernel-doc-nano-HOWTO.txt > > - Arnaldo >
Of course it would be better if code were documented in a consistent and canonical style. The Documentation/kernel-doc-nano-HOWTO.txt method should probably have a one line mention in Chapter 5: Commenting, like this:
--- linux/Documentation/CodingStyle.orig 2003-05-30 18:41:05.000000000 -0600 +++ linux/Documentation/CodingStyle 2003-05-30 22:47:55.000000000 -0600 @@ -164,7 +164,7 @@ small comments to note or warn about something particularly clever (or ugly), but try to avoid excess. Instead, put the comments at the head of the function, telling people what it does, and possibly WHY it does -it. +it. See Documentation/kernel-doc-nano-HOWTO.txt for details. Chapter 6: You've made a mess of it
My purpose with the original patch was to canonify the unusual style discussed above.
The note about the old-style K&R prototypes being deprecated is probably redundant and may be unnecessary, unless someone is copying and pasting from some old System V code, and we all know that makes about as much sense as Boeing secretly looking over the blueprints for the Douglas DC-3.
Steven
- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
| |