diff options
| author | Guido Günther <agx@sigxcpu.org> | 2016-03-12 13:06:57 +0100 |
|---|---|---|
| committer | Guido Günther <agx@sigxcpu.org> | 2016-03-12 13:06:57 +0100 |
| commit | 9ef2aff16da5f6be417c7c6eb94093aecb2982cc (patch) | |
| tree | 66f2d21284729e75a96363048ba114cf00296dc0 /docs | |
| parent | 61ced0ab556b8a4b26fdc935a84deaa266ca119b (diff) | |
Clarify {upstream,debian}-{branch,tag} options
Closes: #817980, #817981
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/manpages/gbp-dch.sgml | 26 |
1 files changed, 19 insertions, 7 deletions
diff --git a/docs/manpages/gbp-dch.sgml b/docs/manpages/gbp-dch.sgml index f7abd7a9..59f4563d 100644 --- a/docs/manpages/gbp-dch.sgml +++ b/docs/manpages/gbp-dch.sgml @@ -64,13 +64,14 @@ <title>DESCRIPTION</title> <para> &gbp-dch; reads git commit messages and generates the &debian; - changelog from it. If no arguments are given, &gbp-dch; verifies - if you're on the <option>debian-branch</option> and starts from - the last tagged Debian package version up to the current tip of - the current branch. If the distribution of the topmost section in - <filename>debian/changelog</filename> is <emphasis>UNRELEASED</emphasis>, - the changelog entries will be inserted into this section. Otherwise, a new - section will be created. + changelog from it. If no arguments are given, &gbp-dch; starts + from the commit corresponding to the last tagged Debian package + version up to the current tip of the current branch. If the + distribution of the topmost section in + <filename>debian/changelog</filename> + is <emphasis>UNRELEASED</emphasis>, the changelog entries will be + inserted into this section. Otherwise, a new section will be + created. </para> <para> If <option>--auto</option> is given &gbp-dch;, tries to guess the @@ -88,6 +89,17 @@ generated changelog entries further, e.g. by using <option>--git-log=</option><replaceable>"--author=Foo Bar"</replaceable>. </para> + <para> + The above relies on the <option>debian-branch</option> option + pointing to the current branch + and <option>upstream-branch</option> pointing to the + corresponding upstream branch in order to find the right merge + points of these branches. Furthermore &gbp-dch; must be able to + identify git tags from upstream and Debian version numbers. If + you're not using the defaults check + the <option>upstream-tag</option> + and <option>debian-tag</option> options. + </para> </refsect1> <refsect1> <title>OPTIONS</title> |