Overview

======
bfiles
======

``bfiles`` is a Mercurial extension for handling large binary files.
You can enable it like any other Mercurial extension: add

  bfiles = /path/to/bfiles.py

to the ``[extensions]`` section of your ``.hgrc`` or ``.hg/hgrc`` file.

See usage.txt for information on using the extension.  


-------
Hacking
-------

If you want to hack on bfiles, design.txt contains obsolete but
easy-to-read design information.  The source code is the final word,
though.

To run the tests, you need a Mercurial source directory for the testing
infrastructure.  The easiest way to do this is to clone hg-crew as a
sibling of hg-bfiles::

  hg clone http://hg.intevation.org/mercurial/crew/ ../hg-crew

Then you can run the bfiles tests::

  cd tests
  ./run-tests.py

Everything you know about running Mercurial's tests applies here.  For
example, you can test bfiles with different Mercurial versions easily::

  hg -R ../hg-crew update 1.3.1
  cd tests
  ./run-tests.py