gbp.scripts.common.pq : API documentation

Common functionality for Debian and RPM patchqueue management

Variable	PQ_BRANCH_PREFIX	Undocumented
Function	is_pq_branch	is branch a patch-queue branch?
Function	pq_branch_name	get the patch queue branch corresponding to branch
Function	pq_branch_base	get the branch corresponding to the given patch queue branch
Function	parse_gbp_commands	Parses gbp commands from commit message. Args with and wthout arguments are supported as is filtering out of commands from the commit body.
Function	patch_path_filter	Create patch include paths, i.e. a "negation" of the exclude paths.
Function	write_patch_file	Write patch file
Variable	DEFAULT_PATCH_NUM_PREFIX_FORMAT	Undocumented
Function	format_patch	Create patch of a single commit
Function	format_diff	Create a patch of diff between two repository objects
Function	get_maintainer_from_control	Get the maintainer from the control file
Function	switch_to_pq_branch	Switch to patch-queue branch if not already on it. doesn't exist yet
Function	apply_single_patch	Undocumented
Function	apply_and_commit_patch	apply a single patch 'patch', add topic 'topic' and commit it
Function	drop_pq	Undocumented

PQ_BRANCH_PREFIX =

Undocumented

(type: str)

def is_pq_branch(branch):

is branch a patch-queue branch?

>>> is_pq_branch("foo")
False
>>> is_pq_branch("patch-queue/foo")
True

def pq_branch_name(branch):

get the patch queue branch corresponding to branch

>>> pq_branch_name("patch-queue/master")
'patch-queue/master'
>>> pq_branch_name("foo")
'patch-queue/foo'

def pq_branch_base(branch):

get the branch corresponding to the given patch queue branch

>>> pq_branch_base("patch-queue/master")
'master'
>>> pq_branch_base("foo")
'foo'

def parse_gbp_commands(info, cmd_tag, noarg_cmds, arg_cmds, filter_cmds=None):

Parses gbp commands from commit message. Args with and wthout arguments are supported as is filtering out of commands from the commit body.

Parameters	info	the commit into to parse for commands
	cmd_tag	the command tag
	noarg_cmds	commands without an argument (type: `list` of `str`)
	arg_cmds	command with an argumnt (type: `list` of `str`)
	filter_cmds	commands to filter out of the passed in info (type: `list` of `str`)
Returns	the parsed commands and the filtered commit body.

def patch_path_filter(file_status, exclude_regex=None):

Create patch include paths, i.e. a "negation" of the exclude paths.

def write_patch_file(filename, commit_info, diff):

Write patch file

DEFAULT_PATCH_NUM_PREFIX_FORMAT =

Undocumented

(type: str)

def format_patch(outdir, repo, commit_info, series, abbrev, numbered=(True), path_exclude_regex=None, topic="""""", name=None, renumber=(False), patch_num_prefix_format=DEFAULT_PATCH_NUM_PREFIX_FORMAT):

Create patch of a single commit

def format_diff(outdir, filename, repo, start, end, abbrev, path_exclude_regex=None):

Create a patch of diff between two repository objects

def get_maintainer_from_control(repo):

Get the maintainer from the control file

def switch_to_pq_branch(repo, branch):

Switch to patch-queue branch if not already on it. doesn't exist yet

def apply_single_patch(repo, branch, patch, fallback_author, topic=None):

Undocumented

def apply_and_commit_patch(repo, patch, fallback_author, topic=None, name=None):

apply a single patch 'patch', add topic 'topic' and commit it

def drop_pq(repo, branch):

Undocumented

API Documentation for git-buildpackage, generated by pydoctor at 2021-02-01 08:15:22.

gbp.scripts.common.pq module documentation

`gbp.scripts.common.pq` module documentation