X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=HACKING;h=d2edcc16ab05aa895ac14290d50db50b8356f07f;hb=7015580d094d7b53002728a393cf913461cef3d6;hp=9d9eff02298542afb5126983020a0a48382d8af6;hpb=63f423bc54152eee82cd9708a2566c8713023994;p=bup.git diff --git a/HACKING b/HACKING index 9d9eff0..d2edcc1 100644 --- a/HACKING +++ b/HACKING @@ -7,23 +7,36 @@ Code Branching Model The master branch is what we consider the main-line of development, and the last, non-rc tag on master is the most recent stable release. -Of course, in all fairness, it has been a *long* time since the last -stable release, but we're working fairly hard to fix that -- no, -seriously. - Any branch with a "tmp/" prefix might be rebased (often), so keep that in mind when using or depending on one. +Any branch with a "tmp/review/" prefix corresponds to a patchset +submitted to the mailing list. We try to maintain these branches to +make the review process easier for those not as familiar with patches +via email. + Current Trajectory ================== -At the moment, the primary goal is to test master in preparation for a -0.25 release, which among many other things will include more complete -support for filesystem metadata. +Now that we've finished the 0.26 release, we're working on 0.27, and +although we're not certain which new features will be included, here +are some possible candidates: + + - Support for transferring saves between repositories and rewriting + branches. + + - Better VFS performance for large repositories (i.e. fuse, ls, + web...). + + - Incremental indexing via inotify. + + - Support for rm/gc. + + - Smarter (and quieter) handling of cross-filesystem metadata. If you have the time and inclination, please help review patches -posted to the list for inclusion in 0.25. (See below.) +posted to the list, or post your own. (See "ways to help" below.) More specific ways to help @@ -35,7 +48,7 @@ With respect to patches, bup development is handled via the mailing list, and all patches should be sent to the list for review (see "Submitting Patches" below). -In most cases, we try to wait until we have at least two +In most cases, we try to wait until we have at least one or two "Reviewed-by:" replies to a patch posted to the list before incorporating it into master, so reviews are an important way to help. We also love a good "Tested-by:" -- the more the merrier. @@ -45,24 +58,23 @@ Submitting patches ================== As mentioned, all patches should be posted to the mailing list for -review. - -You can create a "signed off" (see ./SIGNED-OFF-BY) set of patches in -./pending, ready for submission to the list, like this: +review, and must be "signed off" by the author before official +inclusion (see ./SIGNED-OFF-BY). You can create a "signed off" set of +patches in ./pending, ready for submission to the list, like this: - git format-patch -s -o pending origin/master + git format-patch -s -o patches origin/master which will include all of the patches since origin/master on your current branch. Then you can send them to the list like this: - git send-email --to bup-list@googlegroups.com --compose patches/* + git send-email --to bup-list@googlegroups.com --compose patches/* The use of --compose will cause git to ask you to edit a cover letter that will be sent as the first message. It's also possible to handle everything in one step: - git send-email -s --to bup-list@googlegroups.com --compose origin/master + git send-email -s --to bup-list@googlegroups.com --compose origin/master and you can add --annotate if you'd like to review or edit each patch before it's sent.