mirrors/ntfs-3g
0
0
Fork 0
mirror of https://git.code.sf.net/p/ntfs-3g/ntfs-3g.git synced 2024-11-23 18:14:24 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update doc/CodingStyle

Browse Source 
(Logical change 1.290)
This commit is contained in:
cantab.net!aia21 2004-03-01 12:47:17 +00:00
parent 42d06b623c
commit b99d045075
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/CodingStyle
View File

@ -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.