bzrlib.merge_directive.BaseMergeDirective : API documentation

A request to perform a merge into a branch.

This is the base class that all merge directive implementations should derive from.

Class Variables multiple_output_files Whether or not this merge directive stores a set of revisions in more than one file

Method	__init__	Constructor.
Method	to_lines	Serialize as a list of lines
Method	to_files	Serialize as a set of files.
Method	get_raw_bundle	Return the bundle for this merge directive.
Method	write_to_directory	Write this merge directive to a series of files in a directory.
Class Method	from_objects	Generate a merge directive from various objects
Method	get_disk_name	Generate a suitable basename for storing this directive on disk
Method	to_signed	Serialize as a signed string.
Method	to_email	Serialize as an email message.
Method	install_revisions	Install revisions and return the target revision
Method	compose_merge_request	Compose a request to merge this directive.
Method	_to_lines	Serialize as a list of lines
Static Method	_generate_diff	Undocumented
Static Method	_generate_bundle	Undocumented

def __init__(self, revision_id, testament_sha1, time, timezone, target_branch, patch=None, source_branch=None, message=None, bundle=None):

overridden in bzrlib.merge_directive.MergeDirective, bzrlib.merge_directive.MergeDirective2

Constructor.

Parameters	revision_id	The revision to merge
	testament_sha1	The sha1 of the testament of the revision to merge.
	time	The current POSIX timestamp time
	timezone	The timezone offset
	target_branch	The branch to apply the merge to
	patch	The text of a diff or bundle
	source_branch	A public location to merge the revision from
	message	The message to use when committing this merge

def to_lines(self):

overridden in bzrlib.merge_directive.MergeDirective, bzrlib.merge_directive.MergeDirective2

Serialize as a list of lines

Returns a list of lines

def to_files(self):

Serialize as a set of files.

Returns List of tuples with filename and contents as lines

def get_raw_bundle(self):

overridden in bzrlib.merge_directive.MergeDirective, bzrlib.merge_directive.MergeDirective2

Return the bundle for this merge directive.

Returns bundle text or None if there is no bundle

def _to_lines(self, base_revision=False):

Serialize as a list of lines

Returns a list of lines

def write_to_directory(self, path):

Write this merge directive to a series of files in a directory.

Parameters path Filesystem path to write to

@classmethod
def from_objects(klass, repository, revision_id, time, timezone, target_branch, patch_type='bundle', local_target_branch=None, public_branch=None, message=None):

overridden in bzrlib.merge_directive.MergeDirective2

Generate a merge directive from various objects

The public branch is always used if supplied. If the patch_type is not 'bundle', the public branch must be supplied, and will be verified.

If the message is not supplied, the message from revision_id will be used for the commit.

Parameters	repository	The repository containing the revision
	revision_id	The revision to merge
	time	The POSIX timestamp of the date the request was issued.
	timezone	The timezone of the request
	target_branch	The url of the branch to merge into
	patch_type	'bundle', 'diff' or None, depending on the type of patch desired.
	local_target_branch	a local copy of the target branch
	public_branch	location of a public branch containing the target revision.
	message	Message to use when committing the merge
Returns	The merge directive

def get_disk_name(self, branch):

Generate a suitable basename for storing this directive on disk

Parameters	branch	The Branch this merge directive was generated fro
Returns	A string

@staticmethod
def _generate_diff(repository, revision_id, ancestor_id):

Undocumented

@staticmethod
def _generate_bundle(repository, revision_id, ancestor_id):

overridden in bzrlib.merge_directive.MergeDirective

Undocumented

def to_signed(self, branch):

Serialize as a signed string.

Parameters	branch	The source branch, to get the signing strategy
Returns	a string

def to_email(self, mail_to, branch, sign=False):

Serialize as an email message.

Parameters	mail_to	The address to mail the message to
	branch	The source branch, to get the signing strategy and source email address
	sign	If True, gpg-sign the email
Returns	an email message

def install_revisions(self, target_repo):

Install revisions and return the target revision

def compose_merge_request(self, mail_client, to, body, branch, tree=None):

Compose a request to merge this directive.

Parameters	mail_client	The mail client to use for composing this request.
	to	The address to compose the request to.
	branch	The Branch that was used to produce this directive.
	tree	The Tree (if any) for the Branch used to produce this directive.

b.m.BaseMergeDirective(object) : class documentation