From b99d0450754f6b9866fe83231bdea411f5e34481 Mon Sep 17 00:00:00 2001 From: "cantab.net!aia21" Date: Mon, 1 Mar 2004 12:47:17 +0000 Subject: [PATCH] Update doc/CodingStyle (Logical change 1.290) --- doc/CodingStyle | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/doc/CodingStyle b/doc/CodingStyle index a2606be6..8dc07d1d 100644 --- a/doc/CodingStyle +++ b/doc/CodingStyle @@ -1,13 +1,24 @@ The standard K&R coding style is used in this project and the guidelines -outlined in the Linux kernel CodingStyle document (found in the Linux kernel -main directory in Documentation/CodingStyle) should be adhered to as strictly -as possible. +outlined in the Linux kernel CodingStyle document (found in the latest Linux +kernel main directory in Documentation/CodingStyle) should be adhered to as +strictly as possible. Special notes: Capitals are used when declaring NTFS on-disk structures which you can't just go ahead modifying without getting killed (in a bug sense, - not literally...). In memory structures are named with lower case as + not literally...). In memory structures are named with lower case as usual. + For styles that are not explicitly defined in the document or in the + kernel one, check/read the kernel and/or libntfs source. Some parts + of the kernel might use unwanted coding styles but usually, e.g. + linux/kernel/* + has what Linus prefers/writes and most developers follow. + + The latest Linux kernel contains the script Lindent in the scripts/ + directory which formats the source the most preferred way. Moreover, + the below patch will be applied to the official kernel tree as well: + http://lkml.org/lkml/2004/1/30/180 + Check indent(1) for what the used/unused (default) parameters mean.