From 8d0e82339ffddac23ad38047bb5adc201cc50167 Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Fri, 9 May 2014 14:40:25 +0300 Subject: docs: cosmetic reformat of git-dch manpage sgml source Makes the sgml source more readable. Fix indentation, tab to space, wrap lines. Signed-off-by: Markus Lehtonen --- docs/manpages/gbp-dch.sgml | 354 ++++++++++++++++++++++++++------------------- 1 file changed, 207 insertions(+), 147 deletions(-) (limited to 'docs') diff --git a/docs/manpages/gbp-dch.sgml b/docs/manpages/gbp-dch.sgml index 94a535ac..5d539949 100644 --- a/docs/manpages/gbp-dch.sgml +++ b/docs/manpages/gbp-dch.sgml @@ -9,7 +9,7 @@ - gbp-dch + gbp-dch &dhsection; @@ -20,7 +20,6 @@ &gbp-dch; - branch_name tag-format @@ -28,18 +27,18 @@ - + - - commitish + + commitish version - - - - + + + + name @@ -69,11 +68,14 @@ distribution of the topmost section in debian/changelog is UNRELEASED the changelog entries will be inserted into this section. Otherwise a new - section will be created. - If is given &gbp-dch; tries to guess the + section will be created. + + + If is given &gbp-dch; tries to guess the last &git; commit documented in the changelog - this only works in snapshot mode. Otherwise can be used to tell &gbp-dch; - at which point it should start in the &git; history. + at which point it should start in the &git; history. + The additional path arguments can be used to restrict the repository paths &gbp-dch; looks at. Setting path to @@ -81,106 +83,131 @@ all Debian packaging changes are restricted to the debian/ subdir. In more sophisticated cases (like backports) you can use to restrict the - generated changelog entries further. E.g. by using - "--author=Foo Bar". + generated changelog entries further. E.g. by using + "--author=Foo Bar". + OPTIONS - =branch_name - The branch in the Git repository the Debian package is being - developed on, default is master. + + The branch in the Git repository the Debian package is being + developed on, default is master. + - Don't check if the current branch matches - debian-branch. + + Don't check if the current branch matches + debian-branch. + - - + + - verbose execution + + verbose execution + tag-format - tag format used, when tagging debian versions, - default is debian/%(version)s + + tag format used, when tagging debian versions, + default is debian/%(version)s + committish - Start reading commit messages at committish. + + Start reading commit messages at + committish. + , - + - Guess the last commit documented in the changelog from the - snapshot banner (or from the last tag if no snapshot banner exists). - + + Guess the last commit documented in the changelog from the + snapshot banner (or from the last tag if no snapshot banner exists). + - Parse meta tags like , - and . See META TAGS below. + + Parse meta tags like , + and . See META TAGS + below. + bug-close-tags - What meta tags to look for to generate bug-closing changelog - entries. The default is 'Closes|LP' to support Debian and - Launchpad. + + What meta tags to look for to generate bug-closing changelog entries. + The default is 'Closes|LP' to support Debian and Launchpad. + - + + - Include the full commit message in the changelog output. + + Include the full commit message in the changelog output. + , - Create a snapshot release entry. This adds a snapshot release - number and a warning banner to the changelog entry. The release - version number is being auto incremented with every new snapshot - release to avoid packages downgrades during snapshot testing. + + Create a snapshot release entry. This adds a snapshot release + number and a warning banner to the changelog entry. The release + version number is being auto incremented with every new snapshot + release to avoid packages downgrades during snapshot testing. + expression - Python expression that gets eval()ed to the new snapshot number. + + Python expression that gets eval()ed to the new snapshot number. + , - Remove any snapshot release banners and version suffixes, set - the current distribution to unstable and - open the changelog for final tweaking. + + Remove any snapshot release banners and version suffixes, set + the current distribution to unstable and + open the changelog for final tweaking. + @@ -188,129 +215,157 @@ version - Add a new changelog section with version - newversion. Together with - the snapshot number will be appended to - newversion. + + Add a new changelog section with version + newversion. Together with + the snapshot number will be appended to + newversion. + - + + - Create a Team upload changelog entry. + + Create a Team upload changelog entry. + - Increment the Debian release number for an upload to - backports, and add a backport upload changelog comment. + + Increment the Debian release number for an upload to backports, and + add a backport upload changelog comment. + - Increment the Debian release number for a non-maintainer upload. + + Increment the Debian release number for a non-maintainer upload. + - Increment the Debian release number for a Debian QA Team - upload, and add a QA upload changelog comment. + + Increment the Debian release number for a Debian QA Team upload, and + add a QA upload changelog comment. + - name - - - Set the distribution field - to name. - + name + + + + Set the distribution field to name. + + - - - - Force the distribution specified - with to be used, even if it - doesn't match the list of known distributions. - + + + + + Force the distribution specified with + to be used, even if it doesn't match the list of known distributions. + + - level - - - Set the urgency field - to level. - + level + + + + Set the urgency field to level. + + git-log-options - Options passed on verbatim to git-log(1). + + Options passed on verbatim to git-log(1). + N - Include N digits of the commit id in - the changelog entry. Default is to not include any commit ids at - all. + + Include N digits of the commit id in the + changelog entry. Default is to not include any commit ids at all. + regex - Ignore commit lines matching regex - when generating the changelog. - + + Ignore commit lines matching regex + when generating the changelog. + - Use user.name and user.email from git-config(1) for changelog trailer. + + Use user.name and user.email from + git-config(1) for changelog trailer. + - Merge commits by maintainer. + + Merge commits by maintainer. + - Whether to spawn an editor: always, when doing snapshots or - when doing a release. + + Whether to spawn an editor: always, when doing snapshots or when + doing a release. + msg-format - use this format string for the commit message when - committing the generated changelog file (when - is given). Default is - Update changelog for %(version)s - release + + use this format string for the commit message when committing the + generated changelog file (when is given). + Default is + Update changelog for %(version)s release + - Commit the generated changelog. + + Commit the generated changelog. + @@ -327,27 +382,29 @@ - Snapshot mode - - Snapshot mode can be used for quick test and install cycles without - having to worry about version numbers or changelog entries. - - When using or &gbp-dch; - uses a pseudo header in the Debian changelog to remember the last git - commit it added a changelog entry for. It also sets a version number - ending in - ~<snaspshotnumber>.gbp<commitid>. - It automatically increments the snapshot number on subsequent invocations - of &gbp-dch; so that later snapshots automatically - have a higher version number. To leave snapshot mode invoke &gbp-dch; - with the option. This removes the pseudo - header and unmangles the version number so the released version has a - higher version number than the snapshots. - + Snapshot mode + + Snapshot mode can be used for quick test and install cycles without + having to worry about version numbers or changelog entries. + + + When using or &gbp-dch; + uses a pseudo header in the Debian changelog to remember the last git + commit it added a changelog entry for. It also sets a version number + ending in + ~<snaspshotnumber>.gbp<commitid>. + It automatically increments the snapshot number on subsequent invocations + of &gbp-dch; so that later snapshots automatically + have a higher version number. To leave snapshot mode invoke &gbp-dch; + with the option. This removes the pseudo + header and unmangles the version number so the released version has a + higher version number than the snapshots. + META TAGS - Additional to the above options the formatting of the commit message + + Additional to the above options the formatting of the commit message in debian/changelog can be modified by special tags (called Meta Tags) given in the git commit message. Meta Tag processing can be activated via @@ -360,40 +417,44 @@ : action - - Supported actions are: Ignore which will ignore - this commit when generating debian/changelog, - Short which will only use the - description (the first line) of the commit message when - generating the changelog entry (useful when - is given) and - Full which will use the full commit - message when generating the changelog entry (useful when - is not given). - - - - : msg - - - - Add a thanks message after the commit message. - - - - - : bugnumber - - - - Indicate in the debian/changelog that the bug was - closed by this commit. See the - on how to extend this for other bugtrackers. - - + + + Supported actions are: Ignore which will + ignore this commit when generating + debian/changelog, + Short which will only use the description + (the first line) of the commit message when generating the changelog + entry (useful when is given) and + Full which will use the full commit + message when generating the changelog entry (useful when + is not given). + + + + + : msg + + + + Add a thanks message after the commit message. + + + + + : bugnumber + + + + Indicate in the debian/changelog that the bug + was closed by this commit. See the on + how to extend this for other bugtrackers. + + - The following git commit message: + + The following git commit message: + Document meta tags @@ -404,7 +465,7 @@ Thanks: Raphaël Hertzog for the suggestion - Results in this debian/changelog entry: + Results in this debian/changelog entry: * Document meta tags. @@ -412,11 +473,10 @@ - &man.gbp.config-files; + &man.gbp.config-files; SEE ALSO - , , @@ -430,8 +490,8 @@ AUTHOR - - &dhusername; &dhemail; - + + &dhusername; &dhemail; + -- cgit v1.2.3