Merge branch 'dbus-1.4'
[platform/upstream/dbus.git] / HACKING
1 The guidelines in this file are the ideals; it's better to send a
2 not-fully-following-guidelines patch than no patch at all, though.  We
3 can always polish it up.
4
5 Mailing list
6 ===
7
8 The D-Bus mailing list is dbus@lists.freedesktop.org; discussion
9 of patches, etc. should go there.
10
11 Security
12 ===
13
14 Most of D-Bus is security sensitive.  Guidelines related to that:
15
16  - avoid memcpy(), sprintf(), strlen(), snprintf, strlcat(),
17    strstr(), strtok(), or any of this stuff. Use DBusString. 
18    If DBusString doesn't have the feature you need, add it 
19    to DBusString. 
20
21    There are some exceptions, for example
22    if your strings are just used to index a hash table 
23    and you don't do any parsing/modification of them, perhaps
24    DBusString is wasteful and wouldn't help much. But definitely 
25    if you're doing any parsing, reallocation, etc. use DBusString.
26
27  - do not include system headers outside of dbus-memory.c, 
28    dbus-sysdeps.c, and other places where they are already 
29    included. This gives us one place to audit all external 
30    dependencies on features in libc, etc.
31
32  - do not use libc features that are "complicated" 
33    and may contain security holes. For example, you probably shouldn't
34    try to use regcomp() to compile an untrusted regular expression.
35    Regular expressions are just too complicated, and there are many 
36    different libc's out there.
37
38  - we need to design the message bus daemon (and any similar features)
39    to use limited privileges, run in a chroot jail, and so on.
40
41 http://vsftpd.beasts.org/ has other good security suggestions.
42
43 Coding Style
44 ===
45
46  - The C library uses GNU coding conventions, with GLib-like
47    extensions (e.g. lining up function arguments). The
48    Qt wrapper uses KDE coding conventions.
49
50  - Write docs for all non-static functions and structs and so on. try
51    "doxygen Doxyfile" prior to commit and be sure there are no
52    warnings printed.
53
54  - All external interfaces (network protocols, file formats, etc.)
55    should have documented specifications sufficient to allow an
56    alternative implementation to be written. Our implementation should
57    be strict about specification compliance (should not for example
58    heuristically parse a file and accept not-well-formed
59    data). Avoiding heuristics is also important for security reasons;
60    if it looks funny, ignore it (or exit, or disconnect).
61
62 Development
63 ===
64
65 D-Bus uses Git as its version control system. The main repository is
66 hosted at git.freedesktop.org/dbus/dbus. To clone D-Bus, execute the
67 following command:
68
69     git clone git://git.freedesktop.org/dbus/dbus
70 OR
71     git clone git.freedesktop.org:dbus/dbus
72
73 The latter form is the one that allows pushing, but it also requires
74 an SSH account on the server. The former form allows anonymous
75 checkouts.
76
77 D-Bus development happens in two branches in parallel: the current
78 stable branch, with an even minor number (like 1.0, 1.2 and 1.4), and
79 the next development branch, with the next odd number.
80
81 The stable branch is named after the version number itself (dbus-1.2,
82 dbus-1.4), whereas the development branch is simply known as "master".
83
84 When making a change to D-Bus, do the following:
85
86  - check out the earliest branch of D-Bus that makes sense to have
87    your change in. If it's a bugfix, it's normally the current stable
88    branch; if it's a feature, it's normally the "master" branch. If
89    you have an important security fix, you may want to apply to older
90    branches too.
91
92  - for large changes:
93      if you're developing a new, large feature, it's recommended
94      to create a new branch and do your development there. Publish
95      your branch at a suitable place and ask others to help you
96      develop and test it. Once your feature is considered finalised,
97      you may merge it into the "master" branch.
98
99 - for small changes:
100     . make your change to the source code
101     . execute tests to guarantee that you're not introducing a
102       regression. For that, execute: make check
103       (if possible, add a new test to check the fix you're
104       introducing)
105     . commit your change using "git commit"
106       in the commit message, write a short sentence describing what
107       you did in the first line. Then write a longer description in
108       the next paragraph(s).
109     . repeat the previous steps if necessary to have multiple commits
110
111  - extract your patches and send to the D-Bus mailing list for
112    review or post them to the D-Bus Bugzilla, attaching them to a bug
113    report. To extract the patches, execute:
114      git format-patch origin/master
115
116  - once your code has been reviewed, you may push it to the Git
117    server:
118      git push origin my-branch:remote
119    OR
120      git push origin dbus-X.Y
121    OR
122      git push origin master
123    (consult the Git manual to know which command applies)
124
125  - (Optional) if you've not worked on "master", merge your changes to
126    that branch. If you've worked on an earlier branch than the current
127    stable, merge your changes upwards towards the stable branch, then
128    from there into "master".
129
130     . execute: git checkout master
131     . ensure that you have the latest "master" from the server, update
132       if you don't
133     . execute: git merge dbus-X.Y
134     . if you have any conflicts, resolve them, git add the conflicted
135       files and then git commit
136     . push the "master" branch to the server as well
137
138   Executing this merge is recommended, but not necessary for all
139   changes. You should do this step if your bugfix is critical for the
140   development in "master", or if you suspect that conflicts will arise
141   (you're usually the best person to resolve conflicts introduced by
142   your own code), or if it has been too long since the last merge.
143
144
145 Making a release
146 ===
147
148 To make a release of D-Bus, do the following:
149
150  - check out a fresh copy from Git
151
152  - verify that the libtool versioning/library soname is 
153    changed if it needs to be, or not changed if not
154
155  - update the file NEWS based on the git history
156
157  - verify that the version number of dbus-specification.xml is
158    changed if it needs to be; if changes have been made, update the
159    release date in that file
160
161  - update the AUTHORS file with "make update-authors" if necessary
162
163  - the version number should have major.minor.micro, even
164    if micro is 0, i.e. "1.0.0" and "1.2.0" not "1.0"/"1.2"; the micro
165    version should be even for releases, and odd for intermediate snapshots
166
167  - "make distcheck" (DO NOT just "make dist" - pass the check!)
168
169  - if make distcheck fails, fix it.
170
171  - once distcheck succeeds, "git commit -a".  This is the version
172    of the tree that corresponds exactly to the released tarball.
173
174  - tag the tree with "git tag -s -m 'Released X.Y.Z' dbus-X.Y.Z"
175    where X.Y.Z is the version of the release.  If you can't sign
176    then simply created an unsigned annotated tag:
177    "git tag -a -m 'Released X.Y.Z' dbus-X.Y.Z".
178
179  - bump the version number up in configure.ac (so the micro version is odd),
180    and commit it.  Make sure you do this *after* tagging the previous
181    release! The idea is that git has a newer version number
182    than anything released. Similarly, bump the version number of
183    dbus-specification.xml and set the release date to "(not finalized)".
184
185  - merge the branch you've released to the chronologically-later
186    branch (usually "master"). You'll probably have to fix a merge
187    conflict in configure.ac (the version number).
188
189  - push your changes and the tag to the central repository with
190      git push origin master dbus-X.Y dbus-X.Y.Z
191
192  - scp your tarball to freedesktop.org server and copy it to
193    dbus.freedesktop.org:/srv/dbus.freedesktop.org/www/releases/dbus/dbus-X.Y.Z.tar.gz.
194    This should be possible if you're in group "dbus"
195
196  - Update the online documentation with `make -C doc maintainer-upload-docs`.
197
198  - update the wiki page http://www.freedesktop.org/Software/dbus by
199    adding the new release under the Download heading. Then, cut the
200    link and changelog for the previous that was there.
201
202  - update the wiki page
203    http://www.freedesktop.org/Software/DbusReleaseArchive pasting the
204    previous release. Note that bullet points for each of the changelog
205    items must be indented three more spaces to conform to the
206    formatting of the other releases there.
207   
208  - post to dbus@lists.freedesktop.org announcing the release.
209  
210
211 After making a ".0" stable release
212 ===
213
214 We create a branch for each stable release; sometimes the branch is
215 not done immediately, instead it's possible to wait until someone has
216 a not-suitable-for-stable change they want to make and then branch to
217 allow committing that change.
218
219 The branch name should be dbus-X.Y which is a branch that has
220 releases versioned X.Y.Z
221
222 To branch:
223   git branch dbus-X.Y
224 and upload the branch tag to the server:
225   git push origin dbus-X.Y
226
227 To develop in this branch:
228   git checkout dbus-X.Y
229
230 Environment variables
231 ===
232
233 These are the environment variables that are used by the D-Bus client library
234
235 DBUS_VERBOSE=1
236 Turns on printing verbose messages. This only works if D-Bus has been
237 compiled with --enable-verbose-mode
238
239 DBUS_MALLOC_FAIL_NTH=n
240 Can be set to a number, causing every nth call to dbus_alloc or
241 dbus_realloc to fail. This only works if D-Bus has been compiled with
242 --enable-tests.
243
244 DBUS_MALLOC_FAIL_GREATER_THAN=n
245 Can be set to a number, causing every call to dbus_alloc or
246 dbus_realloc to fail if the number of bytes to be allocated is greater
247 than the specified number. This only works if D-Bus has been compiled with
248 --enable-tests.
249
250 DBUS_TEST_MALLOC_FAILURES=n
251 Many of the D-Bus tests will run over and over, once for each malloc
252 involved in the test. Each run will fail a different malloc, plus some
253 number of mallocs following that malloc (because a fair number of bugs
254 only happen if two or more mallocs fail in a row, e.g. error recovery
255 that itself involves malloc).  This env variable sets the number of
256 mallocs to fail.
257 Here's why you care: If set to 0, then the malloc checking is skipped,
258 which makes the test suite a heck of a lot faster. Just run with this
259 env variable unset before you commit.
260
261 Tests
262 ===
263
264 These are the test programs that are built if dbus is compiled using
265 --enable-tests.
266
267 dbus/dbus-test
268 This is the main unit test program that tests all aspects of the D-Bus
269 client library.
270
271 dbus/bus-test
272 This it the unit test program for the message bus.
273
274 test/break-loader
275 A test that tries to break the message loader by passing it randomly
276 created invalid messages.
277
278 test/name-test/*
279 This is a suite of programs which are run with a temporary session bus.
280 If your test involves multiple processes communicating, your best bet
281 is to add a test in here.
282
283 "make check" runs all the deterministic test programs (i.e. not break-loader).
284
285 "make lcov-check" is available if you configure with --enable-compiler-coverage
286 and gives a complete report on test suite coverage.
287
288 Patches
289 ===
290
291 Please file them at http://bugzilla.freedesktop.org under component
292 dbus, and also post to the mailing list for discussion.  The commit
293 rules are:
294
295  - for fixes that don't affect API or protocol, they can be committed
296    if any one qualified reviewer other than patch author
297    reviews and approves
298
299  - for fixes that do affect API or protocol, two people
300    in the reviewer group have to review and approve the commit, and 
301    posting to the list is definitely mandatory
302
303  - if there's a live unresolved controversy about a change,
304    don't commit it while the argument is still raging.
305
306  - at their discretion, members of the reviewer group may also commit
307    branches/patches under these conditions:
308
309    - the branch does not add or change API, ABI or wire-protocol
310
311    - the branch solves a known problem and is covered by the regression tests
312
313    - there are no objections from the rest of the review group within
314      a week of the patches being attached to Bugzilla
315
316    - the committer gets a positive review on Bugzilla from someone they
317      consider qualified to review the change (e.g. a colleague with D-Bus
318      experience; not necessarily a member of the reviewer group)
319
320  - regardless of reviews, to commit a patch:
321     - make check must pass
322     - the test suite must be extended to cover the new code
323       as much as reasonably feasible (see Tests above)
324     - the patch has to follow the portability, security, and 
325       style guidelines
326     - the patch should as much as reasonable do one thing, 
327       not many unrelated changes
328    No reviewer should approve a patch without these attributes, and
329    failure on these points is grounds for reverting the patch.
330
331 The reviewer group that can approve patches:
332
333 Havoc Pennington <hp@pobox.net>
334 Michael Meeks <michael.meeks@novell.com>
335 Alexander Larsson  <alexl@redhat.com>
336 Zack Rusin <zack@kde.org>
337 Joe Shaw <joe@assbarn.com>
338 Mikael Hallendal <micke@imendio.com>
339 Richard Hult <richard@imendio.com>
340 Owen Fraser-Green <owen@discobabe.net>
341 Olivier Andrieu <oliv__a@users.sourceforge.net>
342 Colin Walters <walters@verbum.org>
343 Thiago Macieira <thiago@kde.org>
344 John Palmieri <johnp@redhat.com>
345 Scott James Remnant <scott@netsplit.com>
346 Will Thompson <will.thompson@collabora.co.uk>
347 Simon McVittie <simon.mcvittie@collabora.co.uk>
348 David Zeuthen <davidz@redhat.com>