1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
-*- mode: text; -*-
$Id: HACKING,v 1.6 2004/05/13 13:38:06 paul Exp $
GUIDELINES FOR HACKING ON QUAGGA
[this is a draft in progress]
Generally, GNU coding standards apply. The indentation style is a bit
different from standard GNU style, and the existing style should be
maintained and used for new code.
Be particularly careful not to break platforms/protocols that you
cannot test.
New code should have good comments, and changes to existing code
should in many cases upgrade the comments when necessary for a
reviewer to conclude that the change has no unintended consequences.
CHANGELOG
Add a ChangeLog entry whenever changing code, except for minor fixes
to a commit (with a ChangeLog entry) within the last few days.
There is at present a mixed style for ChangeLog, with some changes
being described in per-directory ChangeLog files, and some at top
level.
[TBD: resolve per-dir vs top-level, perhaps by reading GNU coding
standards]
PATCH SUBMISSION
* Send a clean diff against the head of CVS in unified diff format, eg by:
cvs <cvs opts> diff -uwb ....
* Include ChangeLog and NEWS entries as appropriate before the patch
(or in it if you are 100% up to date).
* Inclue only one semantic change or group of changes per patch.p
* Do not make gratuitous changes to whitespace. See the w and b arguments
to diff.
* State on which platforms and with what daemons the patch has been
tested. Understand that if the set of testing locations is small,
and the patch might have unforeseen or hard to fix consequences that
there may be a call for testers on quagga-dev, and that the patch
may be blocked until test results appear.
If there are no users for a platform on quagga-dev who are able and
willing to verify -current occasionally, that platform may be
dropped from the "should be checked" list.
PATCH APPLICATION TO CVS
* Only apply patches that meet the submission guidelines.
* If a patch is large (perhaps more than 100 new/changed lines), tag
the repository before and after the change with e.g. before-foo-fix
and after-foo-fix.
* If the patch might break something, issue a call for testing on the
mailinglist.
* Give an appropriate commit message, eg the ChangeLog entry should suffice,
if it does not, then the ChangeLog entry itself needs to be corrected.
* By committing a patch, you are responsible for fixing problems
resulting from it (or backing it out).
STABLE PLATFORMS AND DAEMONS
The list of platforms that should be tested follow. This is a list
derived from what quagga is thought to run on and for which
maintainers can test or there are people on quagga-dev who are able
and willing to verify that -current does or does not work correctly.
BSD (Free, Net or Open, any platform) # without capabilities
GNU/Linux (any distribution, i386)
[future: some 64-bit machine, e.g. NetBSD/sparc64]
[Solaris? (could address 64-bit issue)]
The list of daemons that are thought to be stable and that should be
tested are:
zebra
bgpd
ripd
ospfd
ripngd
IMPORT OR UPDATE VENDOR SPECIFIC ROUTING PROTOCOLS
The source code of Quagga is based on two vendors:
zebra_org (http://www.zebra.org/)
isisd_sf (http://isisd.sf.net/)
In order to import source code, the following procedure should be used:
* Tag the Current Quagga CVS repository:
cvs tag import_isisd_sf_20031223
* Import the source code into the Quagga's framework. You must not modified
this source code. It will be merged later.
cd dir_isisd
export CVSROOT=:pserver:LOGIN@anoncvs.quagga.net:/var/cvsroot
cvs import quagga/isisd isisd_sf isisd_sf_20031223
---COMMENTS---
Vendor: [isisd_sf] Sampo's ISISd from Sourceforge
Tag: [isisd_sf_20031217] Current CVS release
---
* Update your Quagga's directory:
cd dir_quagga
cvs update -dP
or
cvs co -d quagga_isisd quagga
* Merge the code, then commit:
cvs commit
|
