'\" -*- coding: UTF-8 -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH gbp-rpm-ch 1 "1 February 2021" "" "git-buildpackage Manual"
.SH NAME
gbp-rpm-ch; \- Generate the RPM changelog from git commit messages
.SH SYNOPSIS
'nh
.fi
.ad l
\fBgbp rpm-ch\fR \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
[\fB--version\fR] [\fB--help\fR] [\fB--verbose\fR] [\fB--color=\fR[auto|on|off]] [\fB--color-scheme=\fR \fICOLOR_SCHEME\fR] [\fB--tmp-dir\fR= \fIDIRECTORY\fR] [\fB--vendor\fR= \fIVENDOR\fR] [\fB--packaging-branch=\fR \fIBRANCH-NAME\fR] [\fB--packaging-tag=\fR \fITAG-FORMAT\fR] [\fB--ignore-branch\fR] [\fB--packaging-dir=\fR \fIDIRECTORY\fR] [\fB--changelog-file=\fR \fIFILEPATH\fR] [\fB--spec-file=\fR \fIFILEPATH\fR] [\fB--since=\fR \fICOMMITISH\fR] [\fB--no-release\fR] [\fB--[no-]git-author\fR] [\fB--[no-]full\fR] [\fB--id-length=\fR \fINUMBER\fR] [\fB--ignore-regex=\fR \fIREGEX\fR] [\fB--changelog-revision=\fR \fIREV-FORMAT\fR] [\fB--git-log=\fR \fIGIT-LOG-OPTIONS\fR] [\fB--spawn-editor=\fI[always|release|no]\fB\fR] [\fB--editor-cmd=\fR \fIEDITOR\fR] [\fB--customizations=\fR \fICUSTOMIZATION-FILE\fR] \fI[PATH1 PATH2]\fR 
'in \n(.iu-\nxu
.ad b
'hy
.SH DESCRIPTION
\fBgbp rpm-ch\fR reads git commit messages up to the current tip of the current
branch and updates the RPM changelog from them.
.PP
By default, \fBgbp rpm-ch\fR tries to guess the last Git commit documented in
the changelog. Alternatively, \*(T<\fB\-\-since\fR\*(T> can be used to
tell \fBgbp rpm-ch\fR at which point it should start in the Git history, or,
\*(T<\fB\-\-all\fR\*(T> to use all commits from the Git history.
.PP
The additional path arguments can be used to restrict the repository paths
\fBgbp rpm-ch\fR looks at. For even more detailed control, you can use
\*(T<\fB\-\-git\-log\fR\*(T> to restrict the generated changelog entries
further. E.g. by using
\*(T<\fB\-\-git\-log=\fR\*(T>\fI"--author=Foo Bar"\fR.
.SH OPTIONS
.TP 
\*(T<\fB\-\-version\fR\*(T>
Print version of the program, i.e. version of the git-buildpackage
suite
.TP 
\*(T<\fB\-v\fR\*(T>, \*(T<\fB\-\-verbose\fR\*(T>
Verbose execution
.TP 
\*(T<\fB\-h\fR\*(T>, \*(T<\fB\-\-help\fR\*(T>
Print help and exit
.TP 
\*(T<\fB\-\-color=\fR\*(T>[auto|on|off] 
Whether to use colored output.
.TP 
\*(T<\fB\-\-color\-scheme=\fR\*(T>\fICOLOR_SCHEME\fR 
Colors to use in output (when color is enabled). The format for
COLOR_SCHEME is
\&'<debug>:<info>:<warning>:<error>'.
Numerical values and color names are accepted, empty fields imply
the default color. For example,
\*(T<\fB\-\-git\-color\-scheme=\fR\*(T>\*(T<'cyan:34::'\*(T> would
show debug messages in cyan, info messages in blue and other messages
in default (i.e. warning and error messages in red).
.TP 
\*(T<\fB\-\-git\-tmp\-dir\fR\*(T>=\fIDIRECTORY\fR 
Base directory under which temporary directories are created.
.TP 
\*(T<\fB\-\-vendor\fR\*(T>=\fIVENDOR\fR 
Distribution vendor name.
.TP 
\*(T<\fB\-\-packaging\-branch\fR\*(T>=\fIBRANCH-NAME\fR 
The branch in the Git repository the package is being developed on,
default is \fImaster\fR.
.TP 
\*(T<\fB\-\-ignore\-branch\fR\*(T> 
Don't check if the current branch matches
\fIPACKAGING-BRANCH\fR.
.TP 
\*(T<\fB\-\-packaging\-tag=\fR\*(T>\fITAG-FORMAT\fR 
Tag format used, when tagging releases,
default is \fI%(vendor)s/%(version)s\fR
.TP 
\*(T<\fB\-\-packaging\-dir=\fR\*(T>\fIDIRECTORY\fR 
Subdirectory that contains the RPM packaging files.
.TP 
\*(T<\fB\-\-changelog\-file=\fR\*(T>\fIFILEPATH\fR 
Relative path to the changelog file to use. Special value
\fIauto\fR causes \fBgbp\fR to guess,
\fISPEC\fR uses the spec file,
\fICHANGES\fR uses a separate changelog file
(name derived spec file name with .spec suffix replaced by .changes).
Guessing logic is simple: use separate changelog file if it is found,
otherwise use the spec file.
.TP 
\*(T<\fB\-\-spec\-file=\fR\*(T>\fIFILEPATH\fR 
Relative path to the spec file to use. Special value
\fIauto\fR causes \fBgbp\fR to search and guess.
Other values cause the \*(T<\fB\-\-packaging\-dir\fR\*(T> option to be
ignored: the directory of the spec file is used, instead.
.TP 
\*(T<\fB\-\-since=\fR\*(T>\fICOMMITTISH\fR 
Start reading commit messages at
\fICOMMITTISH\fR.
.TP 
\*(T<\fB\-\-no\-release\fR\*(T> 
Do not create a new changelog section, just update the last
changelog section.
.TP 
\*(T<\fB\-\-[no\-]full\fR\*(T> 
Include the full commit message in the changelog output.
.TP 
\*(T<\fB\-\-git\-log=\fR\*(T>\fIGIT-LOG-OPTIONS\fR 
Options passed on verbatim to git-log(1).
.TP 
\*(T<\fB\-\-id\-length=\fR\*(T>\fIN\fR 
Include \fIN\fR digits of the commit id in the
changelog entry. Default is to not include any commit ids at all.
.TP 
\*(T<\fB\-\-ignore\-regex=\fR\*(T>\fIREGEX\fR 
Ignore lines in commit message matching
\fIREGEX\fR when generating the changelog.
.TP 
\*(T<\fB\-\-changelog\-revision=\fR\*(T>\fIREV-FORMAT\fR 
Format string to use for revision field in the changelog header. The
following string fields are accepted:
\fI%(upstreamversion)s\fR the upstream version;
\fI%(release)s\fR the rpm patchlevel, i.e.
Release; \fI%(version)s\fR full rpm package
version; \fI%(tagname)s\fR tag/commit, i.e.
basically what \fBgit-describe\fR would give.
If empty or not defined the default from packaging policy is used.
.TP 
\*(T<\fB\-\-ignore\-regex=\fR\*(T>\fIREGEX\fR 
Ignore commit lines matching \fIREGEX\fR
when generating the changelog.
.TP 
\*(T<\fB\-\-[no\-]git\-author\fR\*(T> 
Use user.name and user.email from
git-config(1) for the changelog header.
.TP 
\*(T<\fB\-\-spawn\-editor=\fR\*(T>\fI[always|release|no]\fR 
Whether to spawn an editor: always, when doing a release or never.
.TP 
\*(T<\fB\-\-editor\-cmd=\fR\*(T>\fIEDITOR\fR 
The editor to use for editing the changelog.
.TP 
\*(T<\fB\-\-customizations=\fR\*(T>\fICUSTOMIZATION-FILE\fR 
Load Python code from \fICUSTOMIZATION-FILE\fR.
At the moment, the only useful thing the code can do is define a
custom ChangelogEntryFormatter class.
.SH "META TAGS"
Additional to the above options the formatting of the new changelog entries
(one-per-commit) in the changelog can be modified by special tags (called
Meta Tags) given in the git commit message. The tags must start at the
first column of a commit message but can appear on any line. They are of
the form \*(T<\fBTagname\fR\*(T>: \fIVALUE\fR. Valid
Meta Tags are:
.TP 
\*(T<\fBGit\-Rpm\-Ch\fR\*(T>: \fIACTION\fR 
Supported actions are: \fIIgnore\fR which will
ignore this commit when generating new changelog entries.
\fIShort\fR which will only use the description
(the first line) of the commit message when generating the changelog
entry (useful when \*(T<\fB\-\-full\fR\*(T> is given) and
\fIFull\fR which will use the full commit
message when generating the changelog entry (useful when
\*(T<\fB\-\-full\fR\*(T> is not given).
.TP 
\*(T<\fB[Close|Closes|...]\fR\*(T>: \fIBUGNUMBER\fR 
Indicate in the changelog entry that bug
\fIBUGNUMBER\fR was addressed in this commit.
.PP
The following git commit message:
.PP
.nf
\*(T<
      Document meta tags

      so one doesn't have to consult the manual

      Git\-Rpm\-Ch: Short
      Closes: #636088
    \*(T>
.fi
.PP
Results in this changelog entry:
.PP
.nf
\*(T<
      \- Document meta tags (Closes: #636088)
    \*(T>
.fi
.SH "CONFIGURATION FILES"
Several \*(T<\fIgbp.conf\fR\*(T> files are parsed 
to set defaults for the above command-line arguments. See the
\fBgbp.conf\fR(5) manpage for details.
.SH "SEE ALSO"
\fBgbp-buildpackage-rpm\fR(1),
\fBgbp-import-srpm\fR(1),
\fBgbp.conf\fR(5),
\fBdebuild\fR(1),
\fBgit\fR(1),
\fBpristine-tar\fR(1),
.URL file:///usr/share/doc/git-buildpackage/manual-html/index.html "       The Git-Buildpackage Manual"
.URL https://honk.sigxcpu.org/cl2vcs "       Cl2vcs"
,
.SH AUTHOR
Markus Lehtonen <\*(T<markus.lehtonen@linux.intel.com\*(T>>