summaryrefslogtreecommitdiff
path: root/source3/CodingSuggestions
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@samba.org>2002-08-17 14:15:33 +0000
committerJelmer Vernooij <jelmer@samba.org>2002-08-17 14:15:33 +0000
commit21d26afb2af6ae34219a4286eb7a8896d7e04a3a (patch)
treeb114286c87c513c83a66104591bbdee5520608c8 /source3/CodingSuggestions
parent592dd249579511f7ce863a42030d9a51ca026c27 (diff)
downloadsamba-21d26afb2af6ae34219a4286eb7a8896d7e04a3a.tar.gz
samba-21d26afb2af6ae34219a4286eb7a8896d7e04a3a.tar.bz2
samba-21d26afb2af6ae34219a4286eb7a8896d7e04a3a.zip
sync 3_0 branch with HEAD
(This used to be commit 19ab776bf9c91cf4e56887fd7a63d3253b7e36ef)
Diffstat (limited to 'source3/CodingSuggestions')
-rw-r--r--source3/CodingSuggestions16
1 files changed, 14 insertions, 2 deletions
diff --git a/source3/CodingSuggestions b/source3/CodingSuggestions
index eda2bee6d0..e5f366ec71 100644
--- a/source3/CodingSuggestions
+++ b/source3/CodingSuggestions
@@ -25,7 +25,11 @@ documents are:
http://www.fsf.org/prep/standards_toc.html
but note that coding style in Samba varies due to the many different
-programmers who have contributed.
+programmers who have contributed.
+
+The indent utility can be used to format C files in the general
+samba coding style. The arguments you should give to indent are:
+-bad -bap -br -ce -cdw -nbc -brs -bbb -nbc -npsl
Following are some considerations you should use when adding new code to
Samba. First and foremost remember that:
@@ -137,12 +141,20 @@ Here are some other suggestions:
to and maintain your code. If it would be hard for someone else to
maintain then do it another way.
+26) Always keep the declaration of a function on one line. The autoprototyper
+ doesn't catch declarations spread over multiple lines.
+ Use:
+static char foo(int bar)
+ and not:
+static char
+foo(int bar)
+
The suggestions above are simply that, suggestions, but the information may
help in reducing the routine rework done on new code. The preceeding list
is expected to change routinely as new support routines and macros are
added.
Written by Steve French, with contributions from Simo Sorce, Andrew
-Bartlett, Tim Potter and Martin Pool.
+Bartlett, Tim Potter, Martin Pool and Jelmer Vernooij.
**/