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