# `gbp.rpm.policy.RpmPkgPolicy.ChangelogEntryFormatter(object)` class documentation

Part of `gbp.rpm.policy.RpmPkgPolicy` (View In Hierarchy)

Helper class for generating changelog entries from git commits

Class Variable | max_entry_line_length | Undocumented
Class Variable | bts_meta_tags | Undocumented
Class Variable | bug_id_re | Undocumented
Class Method | compose | Generate a changelog entry from a git commit.
Class Method | _parse_bts_tags | Parse and filter out bug tracking system related meta tags from commit message.
Class Method | _extra_filter | Filter out specific lines from the commit message.

max_entry_line_length =
Undocumented
(type: `int`)
bts_meta_tags =
Undocumented
(type: `Tuple[str, ...]`)
bug_id_re =
Undocumented
(type: `str`)
@classmethod
def _parse_bts_tags(cls, lines, meta_tags):

Parse and filter out bug tracking system related meta tags from commit message.

Parameters | lines | commit message (type: `list` of `str`)
| meta_tags | meta tags to look for (type: `tuple` of `str`)
Returns | bts-ids per meta tag and the non-mathced lines (type: (`dict`, `list` of `str`))

@classmethod
def _extra_filter(cls, lines, ignore_re):

Filter out specific lines from the commit message.

Parameters | lines | commit message (type: `list` of `str`)
| ignore_re | regexp for matching ignored lines (type: `str`)
Returns | filtered commit message (type: `list` of `str`)

@classmethod
def compose(cls, commit_info, **kwargs):

Generate a changelog entry from a git commit.

Parameters | commit_info | info about the commit (type: `commit_info` object from `gbp.git.repository.GitRepository.get_commit_info()`.)
| kwargs | additional arguments to the compose() method, currently we recognize 'full', 'id_len' and 'ignore_re' (type: `dict`)
Returns | formatted changelog entry (type: `list` of `str`)