Package gbp :: Package scripts :: Package common :: Module pq

[hide private]
[frames] | no frames]

# Module pq

Common functionality for Debian and RPM patchqueue management

Functions | [hide private]

is_pq_branch(branch) is branch a patch-queue branch? |

pq_branch_name(branch) get the patch queue branch corresponding to branch |

pq_branch_base(pq_branch) get the branch corresponding to the given patch queue branch |

parse_gbp_commands(info, cmd_tag, noarg_cmds, arg_cmds, filter_cmds=None) Parses gbp commands from commit message. |

patch_path_filter(file_status, exclude_regex=None) Create patch include paths, i.e. |

write_patch_file(filename, commit_info, diff) Write patch file |

format_patch(outdir, repo, commit_info, series, numbered=True, path_exclude_regex=None, topic=`'````'`, name=None, renumber=False, patch_num_prefix_format=`'``%04d-``'`) Create patch of a single commit |

format_diff(outdir, filename, repo, start, end, path_exclude_regex=None) Create a patch of diff between two repository objects |

get_maintainer_from_control(repo) Get the maintainer from the control file |

switch_to_pq_branch(repo, branch) Switch to patch-queue branch if not already there, create it if it doesn't exist yet |

apply_single_patch(repo, branch, patch, fallback_author, topic=None) |

apply_and_commit_patch(repo, patch, fallback_author, topic=None, name=None) apply a single patch 'patch', add topic 'topic' and commit it |

drop_pq(repo, branch) |

switch_pq(repo, current) Switch to patch-queue branch if on base branch and vice versa |

Variables | [hide private]

| PQ_BRANCH_PREFIX = ``'``patch-queue/``'``
| DEFAULT_PATCH_NUM_PREFIX_FORMAT = ``'``%04d-``'``
| __package__ = ``'``gbp.scripts.common``'``

Function Details | [hide private]

### is_pq_branch(branch)

is branch a patch-queue branch?

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

### pq_branch_name(branch)

get the patch queue branch corresponding to branch

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

### pq_branch_base(pq_branch)

get the branch corresponding to the given patch queue branch

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

### 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` (`list` of `str`) - commands without an argument
  - `arg_cmds` (`list` of `str`) - command with an argumnt
  - `filter_cmds` (`list` of `str`) - commands to filter out of the passed in info
Returns:
  the parsed commands and the filtered commit body.

### patch_path_filter(file_status, exclude_regex=None)

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