HACKING

   1
   2 Conventions?  Are you kidding?  OK fine.
   3
   4 Code Branching Model
   5 ====================
   6
   7 The master branch is what we consider the main-line of development,
   8 and the last, non-rc tag on master is the most recent stable release.
   9
  10 Any branch with a "tmp/" prefix might be rebased (often), so keep that
  11 in mind when using or depending on one.
  12
  13 Any branch with a "tmp/review/" prefix corresponds to a patchset
  14 submitted to the mailing list.  We try to maintain these branches to
  15 make the review process easier for those not as familiar with patches
  16 via email.
  17
  18
  19 Current Trajectory
  20 ==================
  21
  22 Now that we've finished the 0.30 release, we're working on 0.31, and
  23 although we're not certain which new features will be included, here
  24 are likely candidates:
  25
  26   - Accommodation for the upcoming demise of Python 2, most likely via
  27     support for Python 3.
  28
  29 and these are also under consideration:
  30
  31   - Better VFS performance for large repositories (i.e. fuse, ls,
  32     web...).
  33
  34   - Better VFS caching.
  35
  36   - Index improvements.
  37
  38   - Incremental indexing via inotify.
  39
  40   - Smarter (and quieter) handling of cross-filesystem metadata.
  41
  42 If you have the time and inclination, please help review patches
  43 posted to the list, or post your own.  (See "ways to help" below.)
  44
  45
  46 More specific ways to help
  47 ==========================
  48
  49 Testing -- yes please.
  50
  51 With respect to patches, bup development is handled via the mailing
  52 list, and all patches should be sent to the list for review (see
  53 "Submitting Patches" below).
  54
  55 In most cases, we try to wait until we have at least one or two
  56 "Reviewed-by:" replies to a patch posted to the list before
  57 incorporating it into master, so reviews are an important way to help.
  58 We also love a good "Tested-by:" -- the more the merrier.
  59
  60
  61 Testing
  62 =======
  63
  64 You can run the test suite much more quickly via "make -j test" (as
  65 compared to "make test"), at the expense of slightly more confusing
  66 output (interleaved parallel test output), and inaccurate intermediate
  67 success/failure counts, but the final counts displayed should be
  68 correct.
  69
  70 Individual non-Python tests can be run via "./wvtest run t/TEST" and
  71 if you'd like to see all of the test output, you can omit the wvtest
  72 run wrapper: "t/TEST"
  73
  74 Individual Python tests can be run via "./wvtest run ./wvtest.py
  75 lib/bup/t/TEST", and as above, you can see all the output by omitting
  76 the wvtest run wrapper like this: "./wvtest.py lib/bup/t/TEST"
  77
  78
  79 Submitting patches
  80 ==================
  81
  82 As mentioned, all patches should be posted to the mailing list for
  83 review, and must be "signed off" by the author before official
  84 inclusion (see ./SIGNED-OFF-BY).  You can create a "signed off" set of
  85 patches in ./patches, ready for submission to the list, like this:
  86
  87     git format-patch -s -o patches origin/master
  88
  89 which will include all of the patches since origin/master on your
  90 current branch.  Then you can send them to the list like this:
  91
  92     git send-email --to bup-list@googlegroups.com --compose patches/*
  93
  94 The use of --compose will cause git to ask you to edit a cover letter
  95 that will be sent as the first message.
  96
  97 It's also possible to handle everything in one step:
  98
  99     git send-email -s --to bup-list@googlegroups.com --compose origin/master
 100
 101 and you can add --annotate if you'd like to review or edit each patch
 102 before it's sent.
 103
 104 For single patches, this might be easier:
 105
 106     git send-email -s --to bup-list@googlegroups.com --annotate -n1 HEAD
 107
 108 which will send the top patch on the current branch, and will stop to
 109 allow you to add comments.  You can add comments to the section with
 110 the diffstat without affecting the commit message.
 111
 112 Of course, unless your machine is set up to handle outgoing mail
 113 locally, you may need to configure git to be able to send mail.  See
 114 git-send-email(1) for further details.
 115
 116 Oh, and we do have a ./CODINGSTYLE, hobgoblins and all, though don't
 117 let that scare you off.  We're not all that fierce.
 118
 119
 120 Even More Generally
 121 ===================
 122
 123 It's not like we have a lot of hard and fast rules, but some of the
 124 ideas here aren't altogether terrible:
 125
 126   http://www.kernel.org/doc/Documentation/SubmittingPatches
 127
 128 In particular, we've been paying at least some attention to the bits
 129 regarding Acked-by:, Reported-by:, Tested-by: and Reviewed-by:.