X-Git-Url: https://arthur.barton.de/gitweb/?a=blobdiff_plain;f=HACKING;h=9d2f4ff506e5716993edd41b248935bbc9147283;hb=ec26ee2a6b6427e929b7fee2318320c495a2a0aa;hp=1a5f4523329f8c481ba5858397e6ac3e507ca87f;hpb=017af24d11d45541dd20d48568588650cc5ed598;p=bup.git diff --git a/HACKING b/HACKING index 1a5f452..9d2f4ff 100644 --- a/HACKING +++ b/HACKING @@ -19,24 +19,24 @@ via email. Current Trajectory ================== -Now that we've finished the 0.28 release, we're working on 0.29, and -although we're not certain which new features will be included, here -are likely candidates: - - - Support for transferring saves between repositories and rewriting - branches. - -and these are also under consideration: +Now that we've finished the 0.31 release, we're working on 0.32, and +although we're not certain which new features will be included, we're +considering: - Better VFS performance for large repositories (i.e. fuse, ls, web...). + - Better VFS caching. + + - Index improvements. + - Incremental indexing via inotify. - Smarter (and quieter) handling of cross-filesystem metadata. - - Support for more general purpose push/pull of branches, saves, and - tags between repositories. (See the bup-get patch series.) + - Encryption. + + - Support for alternate remote storage APIs. If you have the time and inclination, please help review patches posted to the list, or post your own. (See "ways to help" below.) @@ -60,20 +60,34 @@ 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 tests can be run via + + ./pytest TEST + +For example: + + ./pytest test/int/test_git.py + ./pytest test/ext/test-ftp + +If you have the xdist module installed, then you can specify its `-n` +option to run the tests in parallel (e.g. `./pytest -nauto ...`), or +you can specify `-j` to make, which will be translated to xdist with +`-j` becoming `-nauto` and `-jN` becoming `-nN`. -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" +Internal tests that test bup's code directly are located in test/int, +and external tests that test bup from the outside, typically by +running the executable, are located in test/ext. -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" +Currently, all pytests must be located in either test/ext or test/int. +Internal test filenames must match test_*.py, and external tests must +be located in text/ext and their filenames must match test-* (see +test/ext/conftest.py for the handling of the latter). Any paths +matching those criteria will be automatically collected by pytest. +Some aspects of the environment are automatically restored after each +test via fixtures in conftest.py, including the state of the +environment variables and the working directory; the latter is reset +to the top of the source tree. Submitting patches ================== @@ -112,7 +126,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. -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.