Metion the current code style in the new file called HACKING. In this, we
could also add descriptions on how to send us patches and bug reports etc...
This commit is contained in:
parent
accd865aff
commit
4f76c2b80c
32
HACKING
Normal file
32
HACKING
Normal file
@ -0,0 +1,32 @@
|
||||
|
||||
libssh2 source code style guide:
|
||||
|
||||
- 4 level indent
|
||||
- spaces-only (no tabs)
|
||||
- open braces on the if/for line:
|
||||
|
||||
if (banana) {
|
||||
go_nuts();
|
||||
}
|
||||
|
||||
- write both braces on the else line:
|
||||
|
||||
if (banana) {
|
||||
go_nuts();
|
||||
} else {
|
||||
stay_calm();
|
||||
}
|
||||
|
||||
- use braces even for single-statement blocks
|
||||
|
||||
- keep source lines shorter than 80 columns
|
||||
|
||||
------------
|
||||
|
||||
Older libssh2 code that still hasn't quite transitioned to the above
|
||||
mentioned style, used a different style:
|
||||
|
||||
- indented with tabs (only)
|
||||
|
||||
- no line length limits
|
||||
|
@ -11,7 +11,7 @@ NETWAREFILES = nw/keepscreen.c \
|
||||
nw/nwlibc.c \
|
||||
nw/test/Makefile.netware
|
||||
|
||||
EXTRA_DIST = win32 buildconf $(NETWAREFILES) get_ver.awk
|
||||
EXTRA_DIST = win32 buildconf $(NETWAREFILES) get_ver.awk HACKING
|
||||
|
||||
ACLOCAL_AMFLAGS = -I m4
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user