b.check : module documentation

Part of bzrlib

Checking of bzr objects.

check_refs is a concept used for optimising check. Objects that depend on other
objects (e.g. tree on repository) can list the objects they would be requesting
so that when the dependent object is checked, matches can be pulled out and
evaluated in-line rather than re-reading the same data many times.
check_refs are tuples (kind, value). Currently defined kinds are:
* 'trees', where value is a revid and the looked up objects are revision trees.
* 'lefthand-distance', where value is a revid and the looked up objects are the
  distance along the lefthand path to NULL for that revid.
* 'revision-existence', where value is a revid, and the result is True or False
  indicating that the revision was found/not found.

Class	Check	Check a repository
Function	check	Run consistency checks on a branch.
Function	check_branch	Run consistency checks on a branch.
Function	scan_branch	Scan a branch for refs.
Function	scan_tree	Scan a tree for refs.
Function	check_dwim	Check multiple objects.

@deprecated_function(deprecated_in((1, 6, 0)))
def check(branch, verbose):

Run consistency checks on a branch.

Results are reported through logging.

Deprecated in 1.6. Please use check_dwim instead.

Raises BzrCheckError if there's a consistency error.

@deprecated_function(deprecated_in((1, 16, 0)))
def check_branch(branch, verbose):

Run consistency checks on a branch.

Results are reported through logging.

Raises BzrCheckError if there's a consistency error.

def scan_branch(branch, needed_refs, to_unlock):

Scan a branch for refs.

Parameters	branch	The branch to schedule for checking.
	needed_refs	Refs we are accumulating.
	to_unlock	The unlock list accumulating.

def scan_tree(base_tree, tree, needed_refs, to_unlock):

Scan a tree for refs.

Parameters	base_tree	The original tree check opened, used to detect duplicate tree checks.
	tree	The tree to schedule for checking.
	needed_refs	Refs we are accumulating.
	to_unlock	The unlock list accumulating.

def check_dwim(path, verbose, do_branch=False, do_repo=False, do_tree=False):

Check multiple objects.

If errors occur they are accumulated and reported as far as possible, and an exception raised at the end of the process.

API Documentation for Bazaar, generated by pydoctor at 2010-09-02 00:15:31.