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.31 release, we're working on 0.32, and
  23 although we're not certain which new features will be included, we're
  24 considering:
  25
  26   - Better VFS performance for large repositories (i.e. fuse, ls,
  27     web...).
  28
  29   - Better VFS caching.
  30
  31   - Index improvements.
  32
  33   - Incremental indexing via inotify.
  34
  35   - Smarter (and quieter) handling of cross-filesystem metadata.
  36
  37   - Encryption.
  38
  39   - Support for alternate remote storage APIs.
  40
  41 If you have the time and inclination, please help review patches
  42 posted to the list, or post your own.  (See "ways to help" below.)
  43
  44
  45 More specific ways to help
  46 ==========================
  47
  48 Testing -- yes please.
  49
  50 With respect to patches, bup development is handled via the mailing
  51 list, and all patches should be sent to the list for review (see
  52 "Submitting Patches" below).
  53
  54 In most cases, we try to wait until we have at least one or two
  55 "Reviewed-by:" replies to a patch posted to the list before
  56 incorporating it into master, so reviews are an important way to help.
  57 We also love a good "Tested-by:" -- the more the merrier.
  58
  59
  60 Testing
  61 =======
  62
  63 You can run the test suite much more quickly via "make -j test" (as
  64 compared to "make test"), at the expense of slightly more confusing
  65 output (interleaved parallel test output), and inaccurate intermediate
  66 success/failure counts, but the final counts displayed should be
  67 correct.
  68
  69 Individual non-Python tests can be run via
  70
  71     ./wvtest run test/ext/TEST
  72
  73 and if you'd like to see all of the test output, you can omit the
  74 wvtest run wrapper: `test/ext/TEST`.  Individual Python tests can be
  75 run via
  76
  77     ./pytest test/int/test_something.py
  78
  79 Internal tests that test bup's code directly are located in test/int,
  80 and external tests that test bup from the outside, typically by
  81 running the executable, are located in test/ext.
  82
  83
  84 Some aspects of the environment are automatically restored after each
  85 test via fixtures in conftest.py, including the state of the
  86 environment variables and the working directory; the latter is reset
  87 to the top of the source tree.
  88
  89 Submitting patches
  90 ==================
  91
  92 As mentioned, all patches should be posted to the mailing list for
  93 review, and must be "signed off" by the author before official
  94 inclusion (see ./SIGNED-OFF-BY).  You can create a "signed off" set of
  95 patches in ./patches, ready for submission to the list, like this:
  96
  97     git format-patch -s -o patches origin/master
  98
  99 which will include all of the patches since origin/master on your
 100 current branch.  Then you can send them to the list like this:
 101
 102     git send-email --to bup-list@googlegroups.com --compose patches/*
 103
 104 The use of --compose will cause git to ask you to edit a cover letter
 105 that will be sent as the first message.
 106
 107 It's also possible to handle everything in one step:
 108
 109     git send-email -s --to bup-list@googlegroups.com --compose origin/master
 110
 111 and you can add --annotate if you'd like to review or edit each patch
 112 before it's sent.
 113
 114 For single patches, this might be easier:
 115
 116     git send-email -s --to bup-list@googlegroups.com --annotate -n1 HEAD
 117
 118 which will send the top patch on the current branch, and will stop to
 119 allow you to add comments.  You can add comments to the section with
 120 the diffstat without affecting the commit message.
 121
 122 Of course, unless your machine is set up to handle outgoing mail
 123 locally, you may need to configure git to be able to send mail.  See
 124 git-send-email(1) for further details.
 125
 126 Oh, and we do have a ./CODINGSTYLE, hobgoblins and all, though don't
 127 let that scare you off.  We're not all that fierce.
 128
 129
 130 Even More Generally
 131 ===================
 132
 133 It's not like we have a lot of hard and fast rules, but some of the
 134 ideas here aren't altogether terrible:
 135
 136   http://www.kernel.org/doc/Documentation/SubmittingPatches
 137
 138 In particular, we've been paying at least some attention to the bits
 139 regarding Acked-by:, Reported-by:, Tested-by: and Reviewed-by:.