2 Conventions? Are you kidding? OK fine.
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.
10 Any branch with a "tmp/" prefix might be rebased (often), so keep that
11 in mind when using or depending on one.
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
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
26 - Better VFS performance for large repositories (i.e. fuse, ls,
33 - Incremental indexing via inotify.
35 - Smarter (and quieter) handling of cross-filesystem metadata.
39 - Support for alternate remote storage APIs.
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.)
45 More specific ways to help
46 ==========================
48 Testing -- yes please.
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).
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.
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
69 Individual non-Python tests can be run via "./wvtest run test/TEST" and
70 if you'd like to see all of the test output, you can omit the wvtest
71 run wrapper: "test/TEST"
73 Individual Python tests can be run via "./wvtest run ./wvtest.py
74 test/int/TEST", and as above, you can see all the output by omitting
75 the wvtest run wrapper like this: "./wvtest.py test/TEST"
77 Internal tests that test bup's code directly are located in test/int,
78 and external tests that test bup from the outside, typically by
79 running the executable, are located in test/ext.
85 As mentioned, all patches should be posted to the mailing list for
86 review, and must be "signed off" by the author before official
87 inclusion (see ./SIGNED-OFF-BY). You can create a "signed off" set of
88 patches in ./patches, ready for submission to the list, like this:
90 git format-patch -s -o patches origin/master
92 which will include all of the patches since origin/master on your
93 current branch. Then you can send them to the list like this:
95 git send-email --to bup-list@googlegroups.com --compose patches/*
97 The use of --compose will cause git to ask you to edit a cover letter
98 that will be sent as the first message.
100 It's also possible to handle everything in one step:
102 git send-email -s --to bup-list@googlegroups.com --compose origin/master
104 and you can add --annotate if you'd like to review or edit each patch
107 For single patches, this might be easier:
109 git send-email -s --to bup-list@googlegroups.com --annotate -n1 HEAD
111 which will send the top patch on the current branch, and will stop to
112 allow you to add comments. You can add comments to the section with
113 the diffstat without affecting the commit message.
115 Of course, unless your machine is set up to handle outgoing mail
116 locally, you may need to configure git to be able to send mail. See
117 git-send-email(1) for further details.
119 Oh, and we do have a ./CODINGSTYLE, hobgoblins and all, though don't
120 let that scare you off. We're not all that fierce.
126 It's not like we have a lot of hard and fast rules, but some of the
127 ideas here aren't altogether terrible:
129 http://www.kernel.org/doc/Documentation/SubmittingPatches
131 In particular, we've been paying at least some attention to the bits
132 regarding Acked-by:, Reported-by:, Tested-by: and Reviewed-by:.