]> git.ipfire.org Git - ipfire-3.x.git/blame - doc/coding-style.txt
Added new package: dosfstools.
[ipfire-3.x.git] / doc / coding-style.txt
CommitLineData
0ebfc06d
MT
1###############################################################################
2# #
3# IPFire.org - A linux based firewall #
4# Copyright (C) 2008 Michael Tremer & Christian Schmidt #
5# #
6# This program is free software: you can redistribute it and/or modify #
7# it under the terms of the GNU General Public License as published by #
8# the Free Software Foundation, either version 3 of the License, or #
9# (at your option) any later version. #
10# #
11# This program is distributed in the hope that it will be useful, #
12# but WITHOUT ANY WARRANTY; without even the implied warranty of #
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
14# GNU General Public License for more details. #
15# #
16# You should have received a copy of the GNU General Public License #
17# along with this program. If not, see <http://www.gnu.org/licenses/>. #
18# #
19###############################################################################
20
21 I. The Building System
22 II. Text files
23 III. LFS files
24
25###############################################################################
26# I. The Building System #
27###############################################################################
28
29 - Everything on the building system is kept as it is. Nothing is changed in
30 any way. We have got a toolchain for anything we need.
082638e9
MT
31
32
0ebfc06d
MT
33###############################################################################
34# II. Text files (common rules) #
35###############################################################################
36
37 - In the text files there is a limit of 80 characters per line. Because it
38 sometimes is hard to keep the hard limit is 120 chars.
f088b7ed
MT
39
40 - A tab is as long as 8 space characters.
082638e9 41
0ebfc06d 42 - With a triple X (XXX) we introduce hacks or todos that we can grep them.
082638e9
MT
43
44
0ebfc06d
MT
45###############################################################################
46# III. LFS files #
47###############################################################################
48
82027fc8
MT
49 - Have a look at the format of the configure commands.
50
51 - There is a variable that contains some options for parallel builds called
52 $(PARALLELISMFLAGS). Please comment out it if the makefile has no support
53 for that.
54
0ebfc06d 55 - We don't run test suites. Sorry.
82027fc8 56