Add "do nothing" path_msg to centralize path conversions

[bup.git] / HACKING

diff --git a/HACKING b/HACKING
index f79041d98f18b6ba73ab0adbd2976e8421b6fe1f..6dc10b19aa95319b5ef804e7757fa03b3924e19f 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -7,24 +7,40 @@ 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.
 
 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/" 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
 ==================
 
 
 Current Trajectory
 ==================
 

-At the moment, one of the primary goals is to add support for
-filesystem metadata.  That work is being handled via tmp/pending/meta,
-and we're in the process of trying to vet those patches for master.
-Once that's been done, we're planning to produce a new stable release.
+Now that we've finished the 0.30 release, we're working on 0.31, and
+although we're not certain which new features will be included, here
+are likely candidates:
+
+  - Accommodation for the upcoming demise of Python 2, most likely via
+    support for Python 3.
+
+and these are also under consideration:
+
+  - Better VFS performance for large repositories (i.e. fuse, ls,
+    web...).
+
+  - Better VFS caching.
+
+  - Index improvements.
+
+  - Incremental indexing via inotify.

 
 

-If you have the time and inclination, please help review those patches
-as they're posted to the list.  (See below.)
+  - Smarter (and quieter) handling of cross-filesystem metadata.
+
+If you have the time and inclination, please help review patches
+posted to the list, or post your own.  (See "ways to help" below.)

 
 
 More specific ways to help
 
 
 More specific ways to help


@@ -36,34 +52,51 @@ 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).
 
 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.
 
 
 "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.
 
 

+Testing
+=======
+
+You can run the test suite much more quickly via "make -j test" (as
+compared to "make test"), at the expense of slightly more confusing
+output (interleaved parallel test output), and inaccurate intermediate
+success/failure counts, but the final counts displayed should be
+correct.
+
+Individual non-Python tests can be run via "./wvtest run t/TEST" and
+if you'd like to see all of the test output, you can omit the wvtest
+run wrapper: "t/TEST"
+
+Individual Python tests can be run via "./wvtest run ./wvtest.py
+lib/bup/t/TEST", and as above, you can see all the output by omitting
+the wvtest run wrapper like this: "./wvtest.py lib/bup/t/TEST"
+
+

 Submitting patches
 ==================
 
 As mentioned, all patches should be posted to the mailing list for
 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 ./patches, 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:
 
 
 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:
 
 
 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.
 
 and you can add --annotate if you'd like to review or edit each patch
 before it's sent.


@@ -80,7 +113,7 @@ Of course, unless your machine is set up to handle outgoing mail
 locally, you may need to configure git to be able to send mail.  See
 git-send-email(1) for further details.
 
 locally, you may need to configure git to be able to send mail.  See
 git-send-email(1) for further details.
 

-Oh, and we do have a ./CODING-STYLE, hobgoblins and all, though don't
+Oh, and we do have a ./CODINGSTYLE, hobgoblins and all, though don't

 let that scare you off.  We're not all that fierce.
 
 
 let that scare you off.  We're not all that fierce.