Skip to content

Commit 1f68888

Browse files
committed
Added Markdown to HACKING file
1 parent 291f70e commit 1f68888

File tree

2 files changed

+37
-24
lines changed

2 files changed

+37
-24
lines changed

Diff for: HACKING.md

+35-22
Original file line numberDiff line numberDiff line change
@@ -15,41 +15,54 @@ Here are some directions to get you started:
1515
Helper script to get some uniformity in the style:
1616
$ make style
1717

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).
2019

2120
2. Chase warnings: no warning should be introduced by your changes
2221
Depending what you touch, you can check with:
22+
2323
2.1 When using autotools
24-
$ autoreconf -Wall -vis
24+
25+
$ autoreconf -Wall -vis
26+
2527
2.2 When compiling
28+
2629
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+
3641
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+
4353
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
4758

4859
3. Preserve cross-platform compatility
60+
4961
The source code should remain compilable across various platforms,
5062
including some you probably cannot test alone so keep it in mind.
5163
Supported platforms:
64+
5265
- Linux
5366
- FreeBSD
5467
- Mac OS X
55-
- Windows with Mingw
68+
- Windows with MinGW

Diff for: README-Windows.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ path, this is optional during installation of CMake):
4040
- Now it is possible to run CMake and mingw32-make:
4141

4242
C:\dev\libnfc-read-only> mkdir ..\libnfc-build
43-
C:\dev\libnfc-read-only> cd ..\libnfc-build
44-
C:\dev\libnfc-build> cmake-gui .
43+
C:\dev\libnfc-read-only> cd ..\libnfc-build
44+
C:\dev\libnfc-build> cmake-gui .
4545

4646
Now you can configure the build. Press "Configure", specify "MinGW32 Makefiles"
4747
and then you have the opportunity to set some configuration variables. If you

0 commit comments

Comments
 (0)