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 message-bus-list@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 Making a release
  63 ===
  64
  65 To make a release of D-Bus, do the following:
  66
  67  - check out a fresh copy from CVS
  68
  69  - verify that the libtool versioning/library soname is
  70    changed if it needs to be, or not changed if not
  71
  72  - update the file NEWS based on the ChangeLog
  73
  74  - add a ChangeLog entry containing the version number
  75    you're releasing ("Released 0.3" or something)
  76    so people can see which changes were before and after
  77    a given release.
  78
  79  - "make distcheck" (DO NOT just "make dist" - pass the check!)
  80
  81  - if make distcheck fails, fix it.
  82
  83  - once distcheck succeeds, "cvs commit"
  84
  85  - if someone else made changes and the commit fails,
  86    you have to "cvs up" and run "make distcheck" again
  87
  88  - once the commit succeeds, "cvs tag DBUS_X_Y_Z" where
  89    X_Y_Z map to version X.Y.Z
  90
  91  - bump the version number up in configure.in, and commit
  92    it.  Make sure you do this *after* tagging the previous
  93    release!
  94
  95  - scp your tarball to freedesktop.org server and copy it
  96    to /srv/dbus.freedesktop.org/www/releases. This should
  97    be possible if you're in group "dbus"
  98
  99  - update the wiki page http://www.freedesktop.org/Software/dbus by
 100    adding the new release under the Download heading. Then, cut the
 101    link and changelog for the previous that was there.
 102
 103  - update the wiki page
 104    http://www.freedesktop.org/Software/DbusReleaseArchive pasting the
 105    previous release. Note that bullet points for each of the changelog
 106    items must be indented three more spaces to conform to the
 107    formatting of the other releases there.
 108
 109  - post to dbus@lists.freedesktop.org announcing the release.
 110
 111
 112 Environment variables
 113 ===
 114
 115 These are the environment variables that are used by the D-Bus client library
 116
 117 DBUS_VERBOSE=1
 118 Turns on printing verbose messages. This only works if D-Bus has been
 119 compiled with --enable-verbose-mode
 120
 121 DBUS_MALLOC_FAIL_NTH=n
 122 Can be set to a number, causing every nth call to dbus_alloc or
 123 dbus_realloc to fail. This only works if D-Bus has been compiled with
 124 --enable-tests.
 125
 126 DBUS_MALLOC_FAIL_GREATER_THAN=n
 127 Can be set to a number, causing every call to dbus_alloc or
 128 dbus_realloc to fail if the number of bytes to be allocated is greater
 129 than the specified number. This only works if D-Bus has been compiled with
 130 --enable-tests.
 131
 132 DBUS_TEST_MALLOC_FAILURES=n
 133 Many of the D-Bus tests will run over and over, once for each malloc
 134 involved in the test. Each run will fail a different malloc, plus some
 135 number of mallocs following that malloc (because a fair number of bugs
 136 only happen if two or more mallocs fail in a row, e.g. error recovery
 137 that itself involves malloc).  This env variable sets the number of
 138 mallocs to fail.
 139 Here's why you care: If set to 0, then the malloc checking is skipped,
 140 which makes the test suite a heck of a lot faster. Just run with this
 141 env variable unset before you commit.
 142
 143 Tests
 144 ===
 145
 146 These are the test programs that are built if dbus is compiled using
 147 --enable-tests.
 148
 149 dbus/dbus-test
 150 This is the main unit test program that tests all aspects of the D-Bus
 151 client library.
 152
 153 dbus/bus-test
 154 This it the unit test program for the message bus.
 155
 156 test/break-loader
 157 A test that tries to break the message loader by passing it randomly
 158 created invalid messages.
 159
 160 "make check" runs all the deterministic test programs (i.e. not break-loader).
 161
 162 "make check-coverage" is available if you configure with --enable-gcov and
 163 gives a complete report on test suite coverage. You can also run
 164 "test/decode-gcov foo.c" on any source file to get annotated source,
 165 after running make check with a gcov-enabled tree.
 166
 167 Patches
 168 ===
 169
 170 Please file them at http://bugzilla.freedesktop.org under component
 171 dbus, and also post to the mailing list for discussion.  The commit
 172 rules are:
 173
 174  - for fixes that don't affect API or protocol, they can be committed
 175    if any one qualified reviewer other than patch author
 176    reviews and approves
 177
 178  - for fixes that do affect API or protocol, two people
 179    in the reviewer group have to review and approve the commit, and
 180    posting to the list is definitely mandatory
 181
 182  - if there's a live unresolved controversy about a change,
 183    don't commit it while the argument is still raging.
 184
 185  - regardless of reviews, to commit a patch:
 186     - make check must pass
 187     - the test suite must be extended to cover the new code
 188       as much as reasonably feasible
 189     - the patch has to follow the portability, security, and
 190       style guidelines
 191     - the patch should as much as reasonable do one thing,
 192       not many unrelated changes
 193    No reviewer should approve a patch without these attributes, and
 194    failure on these points is grounds for reverting the patch.
 195
 196 The reviewer group that can approve patches: Havoc Pennington, Michael
 197 Meeks, Alex Larsson, Zack Rusin, Joe Shaw, Mikael Hallendal, Richard
 198 Hult, Owen Fraser-Green, Olivier Andrieu, Colin Walters.
 199
 200