@@ -15,41 +15,54 @@ Here are some directions to get you started:
15
15
Helper script to get some uniformity in the style:
16
16
$ make style
17
17
18
- If you use vim see the "Vim: How to prevent trailing whitespaces"
19
- http://www.carbon-project.org/Vim__How_to_prevent_trailing_whitespaces.html
18
+ If you use vim see the [ Vim: How to prevent trailing whitespaces] ( http://www.carbon-project.org/Vim__How_to_prevent_trailing_whitespaces.html ) .
20
19
21
20
2 . Chase warnings: no warning should be introduced by your changes
22
21
Depending what you touch, you can check with:
22
+
23
23
2.1 When using autotools
24
- $ autoreconf -Wall -vis
24
+
25
+ $ autoreconf -Wall -vis
26
+
25
27
2.2 When compiling
28
+
26
29
2.2.1 Using extra flags:
27
- $ export CFLAGS="-Wall -g -O2 -Wextra -pipe -funsigned-char -fstrict-aliasing \
28
- -Wchar-subscripts -Wundef -Wshadow -Wcast-align -Wwrite-strings -Wunused \
29
- -Wuninitialized -Wpointer-arith -Wredundant-decls -Winline -Wformat \
30
- -Wformat-security -Wswitch-enum -Winit-self -Wmissing-include-dirs \
31
- -Wmissing-prototypes -Wstrict-prototypes -Wold-style-definition \
32
- -Wbad-function-cast -Wnested-externs -Wmissing-declarations"
33
- $ ./configure
34
- $ make clean
35
- $ make
30
+
31
+ $ export CFLAGS="-Wall -g -O2 -Wextra -pipe -funsigned-char -fstrict-aliasing \
32
+ -Wchar-subscripts -Wundef -Wshadow -Wcast-align -Wwrite-strings -Wunused \
33
+ -Wuninitialized -Wpointer-arith -Wredundant-decls -Winline -Wformat \
34
+ -Wformat-security -Wswitch-enum -Winit-self -Wmissing-include-dirs \
35
+ -Wmissing-prototypes -Wstrict-prototypes -Wold-style-definition \
36
+ -Wbad-function-cast -Wnested-externs -Wmissing-declarations"
37
+ $ ./configure
38
+ $ make clean
39
+ $ make
40
+
36
41
2.2.2 Using clang:
37
- You can use same CFLAGS but also "-Wunreachable-code"
38
- $ scan-build ./configure
39
- $ make clean
40
- $ scan-build make
41
- 2.2.3 Using cppcheck (v1.58 or higher):
42
- $ make cppcheck
42
+
43
+ You can use same CFLAGS but also `-Wunreachable-code`
44
+
45
+ $ scan-build ./configure
46
+ $ make clean
47
+ $ scan-build make
48
+
49
+ 2.2.3 Using `cppcheck` (v1.58 or higher):
50
+
51
+ $ make cppcheck
52
+
43
53
2.3 When Debianizing
44
- $ lintian --info --display-info --display-experimental * deb
45
- or (shorter version)
46
- $ lintian -iIE * deb
54
+
55
+ $ lintian --info --display-info --display-experimental *deb
56
+ or (shorter version)
57
+ $ lintian -iIE *deb
47
58
48
59
3 . Preserve cross-platform compatility
60
+
49
61
The source code should remain compilable across various platforms,
50
62
including some you probably cannot test alone so keep it in mind.
51
63
Supported platforms:
64
+
52
65
- Linux
53
66
- FreeBSD
54
67
- Mac OS X
55
- - Windows with Mingw
68
+ - Windows with MinGW
0 commit comments