From c365f7c19df412b259a3a52e213f31626e3cb75f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guido=20G=C3=BCnther?= Date: Wed, 26 Jun 2013 13:32:32 +0200 Subject: Rename the sgml files from git- to gbp- --- docs/Makefile | 10 +- docs/man.gbp-buildpackage.sgml | 11 + docs/man.gbp-dch.sgml | 11 + docs/man.gbp-import-dsc.sgml | 11 + docs/man.gbp-import-dscs.sgml | 11 + docs/man.gbp-import-orig.sgml | 11 + docs/man.git-buildpackage.sgml | 11 - docs/man.git-dch.sgml | 11 - docs/man.git-import-dsc.sgml | 11 - docs/man.git-import-dscs.sgml | 11 - docs/man.git-import-orig.sgml | 11 - docs/manpages/gbp-buildpackage.sgml | 489 ++++++++++++++++++++++++++++++ docs/manpages/gbp-clone.sgml | 2 +- docs/manpages/gbp-create-remote-repo.sgml | 2 +- docs/manpages/gbp-dch.sgml | 441 +++++++++++++++++++++++++++ docs/manpages/gbp-import-dsc.sgml | 221 ++++++++++++++ docs/manpages/gbp-import-dscs.sgml | 112 +++++++ docs/manpages/gbp-import-orig.sgml | 239 +++++++++++++++ docs/manpages/gbp-pull.sgml | 2 +- docs/manpages/gbp.sgml | 2 +- docs/manpages/git-buildpackage.sgml | 489 ------------------------------ docs/manpages/git-dch.sgml | 441 --------------------------- docs/manpages/git-import-dsc.sgml | 221 -------------- docs/manpages/git-import-dscs.sgml | 112 ------- docs/manpages/git-import-orig.sgml | 239 --------------- docs/manpages/manpages.ent | 12 +- docs/manual.sgml | 10 +- 27 files changed, 1577 insertions(+), 1577 deletions(-) create mode 100644 docs/man.gbp-buildpackage.sgml create mode 100644 docs/man.gbp-dch.sgml create mode 100644 docs/man.gbp-import-dsc.sgml create mode 100644 docs/man.gbp-import-dscs.sgml create mode 100644 docs/man.gbp-import-orig.sgml delete mode 100644 docs/man.git-buildpackage.sgml delete mode 100644 docs/man.git-dch.sgml delete mode 100644 docs/man.git-import-dsc.sgml delete mode 100644 docs/man.git-import-dscs.sgml delete mode 100644 docs/man.git-import-orig.sgml create mode 100644 docs/manpages/gbp-buildpackage.sgml create mode 100644 docs/manpages/gbp-dch.sgml create mode 100644 docs/manpages/gbp-import-dsc.sgml create mode 100644 docs/manpages/gbp-import-dscs.sgml create mode 100644 docs/manpages/gbp-import-orig.sgml delete mode 100644 docs/manpages/git-buildpackage.sgml delete mode 100644 docs/manpages/git-dch.sgml delete mode 100644 docs/manpages/git-import-dsc.sgml delete mode 100644 docs/manpages/git-import-dscs.sgml delete mode 100644 docs/manpages/git-import-orig.sgml diff --git a/docs/Makefile b/docs/Makefile index 3540e676..93dd1352 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,10 +1,10 @@ #!/usr/bin/make -MAN1S = git-buildpackage \ - git-import-dsc \ - git-import-dscs \ - git-import-orig \ - git-dch \ +MAN1S = gbp-buildpackage \ + gbp-import-dsc \ + gbp-import-dscs \ + gbp-import-orig \ + gbp-dch \ gbp \ gbp-pull \ gbp-clone \ diff --git a/docs/man.gbp-buildpackage.sgml b/docs/man.gbp-buildpackage.sgml new file mode 100644 index 00000000..e6496696 --- /dev/null +++ b/docs/man.gbp-buildpackage.sgml @@ -0,0 +1,11 @@ + + %COMMON; + + %MANPAGES; +]> + + +git-buildpackage Manual +&man.gbp.buildpackage; + diff --git a/docs/man.gbp-dch.sgml b/docs/man.gbp-dch.sgml new file mode 100644 index 00000000..a31e12c5 --- /dev/null +++ b/docs/man.gbp-dch.sgml @@ -0,0 +1,11 @@ + + %COMMON; + + %MANPAGES; +]> + + +git-buildpackage Manual +&man.gbp.dch; + diff --git a/docs/man.gbp-import-dsc.sgml b/docs/man.gbp-import-dsc.sgml new file mode 100644 index 00000000..6e1d02d3 --- /dev/null +++ b/docs/man.gbp-import-dsc.sgml @@ -0,0 +1,11 @@ + + %COMMON; + + %MANPAGES; +]> + + +git-buildpackage Manual +&man.gbp.importdsc; + diff --git a/docs/man.gbp-import-dscs.sgml b/docs/man.gbp-import-dscs.sgml new file mode 100644 index 00000000..1fb47ee3 --- /dev/null +++ b/docs/man.gbp-import-dscs.sgml @@ -0,0 +1,11 @@ + + %COMMON; + + %MANPAGES; +]> + + +git-buildpackage Manual +&man.gbp.importdscs; + diff --git a/docs/man.gbp-import-orig.sgml b/docs/man.gbp-import-orig.sgml new file mode 100644 index 00000000..c64bffe7 --- /dev/null +++ b/docs/man.gbp-import-orig.sgml @@ -0,0 +1,11 @@ + + %COMMON; + + %MANPAGES; +]> + + +git-buildpackage Manual +&man.gbp.importorig; + diff --git a/docs/man.git-buildpackage.sgml b/docs/man.git-buildpackage.sgml deleted file mode 100644 index 8708e845..00000000 --- a/docs/man.git-buildpackage.sgml +++ /dev/null @@ -1,11 +0,0 @@ - - %COMMON; - - %MANPAGES; -]> - - -git-buildpackage Manual -&man.git.buildpackage; - diff --git a/docs/man.git-dch.sgml b/docs/man.git-dch.sgml deleted file mode 100644 index 797f372a..00000000 --- a/docs/man.git-dch.sgml +++ /dev/null @@ -1,11 +0,0 @@ - - %COMMON; - - %MANPAGES; -]> - - -git-buildpackage Manual -&man.git.dch; - diff --git a/docs/man.git-import-dsc.sgml b/docs/man.git-import-dsc.sgml deleted file mode 100644 index e770900f..00000000 --- a/docs/man.git-import-dsc.sgml +++ /dev/null @@ -1,11 +0,0 @@ - - %COMMON; - - %MANPAGES; -]> - - -git-buildpackage Manual -&man.git.importdsc; - diff --git a/docs/man.git-import-dscs.sgml b/docs/man.git-import-dscs.sgml deleted file mode 100644 index 3777e895..00000000 --- a/docs/man.git-import-dscs.sgml +++ /dev/null @@ -1,11 +0,0 @@ - - %COMMON; - - %MANPAGES; -]> - - -git-buildpackage Manual -&man.git.importdscs; - diff --git a/docs/man.git-import-orig.sgml b/docs/man.git-import-orig.sgml deleted file mode 100644 index c77dab24..00000000 --- a/docs/man.git-import-orig.sgml +++ /dev/null @@ -1,11 +0,0 @@ - - %COMMON; - - %MANPAGES; -]> - - -git-buildpackage Manual -&man.git.importorig; - diff --git a/docs/manpages/gbp-buildpackage.sgml b/docs/manpages/gbp-buildpackage.sgml new file mode 100644 index 00000000..c7fc528c --- /dev/null +++ b/docs/manpages/gbp-buildpackage.sgml @@ -0,0 +1,489 @@ + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + + gbp-buildpackage + &dhsection; + + + git-buildpackage + gbp-buildpackage + Build Debian packages from a Git repository + + + + &gbp-buildpackage; + + + + [auto|on|off] + [auto|on|off] + treeish + branch_name + + BUILD_CMD + CLEAN_CMD + + + DIST + ARCH + + + + gpg-keyid + command + command + command + command + + tag-format + tag-format + + + [TAG|BRANCH|treeish] + directory + type + level + directory + treeish + + + + + + + + + + DESCRIPTION + + &gbp-buildpackage; is used to build Debian source and .deb packages from a &git; repository. + + + &gbp-buildpackage; will, in order: + + + Verify that it is being executed from the + proper location. + + Verify that the repository doesn't contain any + uncommitted source changes. + + Verify that it is being executed from the + correct branch. + + + (Optionally) export the source tree to a separate build area + + Build an orig tarball if it doesn't exist. + + Call debuild(1) + (or the application specified via ) + with arguments instructing it to ignore &git; meta-data in + the diff.gz, passing along all arguments given to + &gbp-buildpackage; that don't start with --git-. + + + + (Optionally) tag the tree after a successful build + + + (Optionally) call a post build hook - e.g. to run &lintian; + + + (Optionally) call a post tag hook - e.g. to push the results to a remote + repository after creating the tag + + + + + OPTIONS + + + + + + + Don't abort if there are uncommitted changes in the source tree + or the current branch doesn't match the + debian-branch. + + + + + + + Add a git tag after a successful build. + + + + + + Use BUILD_CMD instead of debuild -i -I + + + + + + Use CLEAN_CMD instead of debuild clean + + + + + + Build package using git-pbuilder. Note that + this overwrites any and + options. + + + + + + Build package using git-pbuilder with + qemubuilder. Note that this overwrites any + and + options. + + + + + + Build for distribution DIST when + using --git-pbuilder. If unset build for the + unstable distribution. + + + + + + Build for architecture ARCH when + using --git-pbuilder. If unset no architecture is + passed to git-pbuilder. + + + + + + Whether to try to autoconfigure + git-pbuilder or to rely on the settings in + .pbuilderrc. See the git-pbuilder + manpage for details. + + + + + Options to pass to pbuilder + + + + + + + verbose execution + + + + [auto|on|off] + + + Whether to use colored output. + + + + [auto|on|off] + + + Whether to send a desktop notification after the build. + + + + =branch_name + + + Branch to build the orig tarball from if + is set to BRANCH. Default is + upstream. + + + + =branch_name + + + If you're not on this branch when invoking &gbp-buildpackage; + it will fail. Default is master. This is + done to make sure you don't accidentally release from a topic branch. + Not being on this branch will be ignored when using + . + + + + + + + + Don't check if the current branch matches + debian-branch. + + + + + + + GPG sign all created tags + + + + gpg-keyid + + + use this keyid for gpg signing tags + + + + command + + + excecute command after tagging a new + version.Exported environment variables are: + GBP_TAG (the name of the generated tag), + GBP_BRANCH (the branch the package was build from) and + GBP_SHA1 (the sha1 of the commit the tag was created + at). + + + + command + + + execute command after successful + build. Exported environment variables are: + GBP_CHANGES_FILE (the name of the generated changes + file), GBP_BUILD_DIR (the build dir). + + + + command + + + execute command after exporting the source + tree - valid only if --git-export-dir has been specified. + Exported environment variables are: + GBP_GIT_DIR (the repository the package is being built + from), GBP_TMP_DIR (the temporary directory where the + sources have been initially exported). + + + + command + + + execute command from the build + directory before calling debuild + or the application specified via . + Exported environment variables are: + GBP_GIT_DIR (the repository the package is being built from), + GBP_BUILD_DIR (the build dir). + + + + + + Enable running all (cleaner, postexport, prebuild, postbuild, + and posttag) hooks. Note: the command is + not affected by this option. + + + + tag-format + + + use this tag format when tagging Debian versions, + default is debian/%(version)s + + + + tag-format + + + use this tag format when looking for tags of upstream versions, + default is upstream/%(version)s. + + + + + + + Force creation of an orig tarball (overwriting a pre-existing one if present) + + + + + + + Don't try to create any orig tarball + + + + + + + Extract orig tarball when using export-dir option (analog to mergeWithUpstream in svn-bp) + + + + directory + + + Export the current branch head (or the treeish object given via + to directory + before building. + + + + treeish + + + Instead of exporting the current branch head, export the + treeish object treeish. The special name + INDEX exports the current index whereas + the special name WC exports the current working + copy as is. + + + + [tag|branch] + + + How to find the upstream sources used to generate the tarball. + TAG looks at a tag corresponding to the + version in the changelog. BRANCH looks at + the upstream branch given via the + option. Other values are interpreted as treeishs. + + This doesn't have any effect if + is being used. + + + + + directory + + + Search for original tarballs in directory instead of generating them + + + + type + + + Specifies the upstream tarball compression type. This will be + used to locate and build the upstream tarball if necessary. The + default is auto which derives the + compression type from the pristine-tar branch if available and falls + back to gzip otherwise. Other options are + gzip, bzip2, + lzma and xz. + + + + + level + + + Specifies the upstream tarball compression level if an upstream tarball needs to be built. + + + + + + + Purge (remove) temporary build directory after build + + + + + + + Deprecated, use --git-no-purge instead. + + + + + + + don't build, only tag and run post-tag hooks + + + + + + + don't fail tag operations if a tag with the same version + already exists + + + + + + + Use pristine-tar when generating the upstream tarball if it doesn't exist. + + + + + + + Commit the pristine-tar delta to the pristine-tar branch if a new tarball was + generated and the pristine-tar data isn't already there. + + + + + + &man.gbp.config-files; + All options in the config files are specified without the 'git-' prefix. + + + SEE ALSO + + + gbp-import-dsc + 1 + , + + gbp-import-dscs + 1 + , + + gbp-import-orig + 1 + , + + gbp-dch + 1 + , + + git-pbuilder + 1 + , + + gbp.conf + &dhconfsection; + + &man.seealso.common; + + + + AUTHOR + + &dhusername; &dhemail; + + + diff --git a/docs/manpages/gbp-clone.sgml b/docs/manpages/gbp-clone.sgml index 1b01401d..c63db2f5 100644 --- a/docs/manpages/gbp-clone.sgml +++ b/docs/manpages/gbp-clone.sgml @@ -91,7 +91,7 @@ - &man.git.config-files; + &man.gbp.config-files; SEE ALSO diff --git a/docs/manpages/gbp-create-remote-repo.sgml b/docs/manpages/gbp-create-remote-repo.sgml index 19bf4558..08c621a5 100644 --- a/docs/manpages/gbp-create-remote-repo.sgml +++ b/docs/manpages/gbp-create-remote-repo.sgml @@ -136,7 +136,7 @@ - &man.git.config-files; + &man.gbp.config-files; SEE ALSO diff --git a/docs/manpages/gbp-dch.sgml b/docs/manpages/gbp-dch.sgml new file mode 100644 index 00000000..96e42f55 --- /dev/null +++ b/docs/manpages/gbp-dch.sgml @@ -0,0 +1,441 @@ + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + + gbp-dch + &dhsection; + + + git-dch; + gbp-dch; + Generate the Debian changelog from git commit messages + + + + &gbp-dch; + + + branch_name + tag-format + tag-format + + + + + + + + commitish + + version + + + + + + + name + + level + + + + expression + number + git-log-options + + + + + msg-format + + customization-file + [path1 path2] + + + + DESCRIPTION + + &gbp-dch; reads git commit messages and generates the Debian changelog from + it. If no arguments are given &gbp-dch; 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 + 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 + 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. + + The additional path arguments can be used to restrict the repository paths + &gbp-dch; looks at. Setting path to + debian/ is a good choice if upstream uses &git; and + 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". + + + OPTIONS + + + + =branch_name + + + 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. + + + + + + + verbose execution + + + + tag-format + + + tag format used, when tagging debian versions, + default is debian/%(version)s + + + + 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). + + + + + + + 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. + + + + + + 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. + + + + expression + + + 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. + + + + version, + version + + + Add a new changelog section with version + newversion. Together with + the snapshot number will be appended to + newversion. + + + + + + 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 a non-maintainer upload. + + + + + + + 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. + + + + + + + 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. + + + + git-log-options + + + 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. + + + + regex + + + Ignore commit lines matching regex + when generating the changelog. + + + + + + + + Use user.name and user.email from git-config(1) for changelog trailer. + + + + + + + Merge commits by maintainer. + + + + + + + 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 + + + + + + + Commit the generated changelog. + + + + + + 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 + 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 + the option. The tags must start at the first column of + a commit message but can appear on any line. + They are of the form : + value. Valid Meta Tags are: + + + + : 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. + + + + + The following git commit message: + + Document meta tags + + so one doesn't have to consult the manual + + Git-Dch: Short + Closes: #636088 + Thanks: Raphaël Hertzog for the suggestion + + + Results in this debian/changelog entry: + + + * Document meta tags. + Thanks to Raphaël Hertzog for the suggestion (Closes: #636088) + + + + &man.gbp.config-files; + + + SEE ALSO + + + + gbp-buildpackage + 1 + , + + gbp-import-dsc + 1 + , + + gbp-import-dscs + 1 + , + + gbp-import-orig + 1 + , + + gbp.conf + &dhconfsection; + , + &man.seealso.common; + + Cl2vcs, + + + + AUTHOR + + &dhusername; &dhemail; + + + diff --git a/docs/manpages/gbp-import-dsc.sgml b/docs/manpages/gbp-import-dsc.sgml new file mode 100644 index 00000000..52d8d434 --- /dev/null +++ b/docs/manpages/gbp-import-dsc.sgml @@ -0,0 +1,221 @@ + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + + gbp-import-dsc + &dhsection; + + + git-import-dsc + gbp-import-dsc + Import Debian packages into a Git repository + + + + &gbp-import-dsc; + + + branch_name + branch_name + + gpg-keyid + tag-format + tag-format + pattern + + + + + + debian-source.dsc + + + &gbp-import-dsc; + + + + + + URL + source-package + + + + + DESCRIPTION + + &gbp-import-dsc; imports a Debian source package into a &git; repository, + notes the package version in the commit logs, and commits the change. All + information, including package name, version, Debian diffs, and upstream + source is automatically detected from the source package. + + + + OPTIONS + + + + =branch_name + + + The branch in the &git; repository the upstream sources are put + onto. Default is upstream. + + + + =branch_name + + + The branch in the &git; repository the debian sources are put + onto. Default is master. + + + + + + + verbose execution + + + + + + + GPG sign all created tags + + + + gpg-keyid + + + use this keyid for gpg signing tags + + + + tag-format + + + use this tag format when tagging Debian versions, + default is debian/%(version)s + + + + tag-format + + + use this tag format when tagging upstream versions, + default is upstream/%(version)s + + + + pattern + + + filter out files glob-matching pattern. Can be given multiple times. + + + + + + + generate pristine-tar delta file + + + + + + + Download the source package instead of looking for it in the local + file system. The argument can either be a + source-package name or an + URL. The former uses &apt-get; to download + the source while the later uses &dget;. + + + + + + + + Whether to skip signature verification on downloads. + + + + + + + Allow to import a package with the same debian version. + + + + + + + When importing the Debian patch, use the author identity as + comitter identity. + + + + + + + When importing the Debian patch, use the author date as + comitter date. Git will subtly misbehave if the + committer date of a commit is not later than or equal to all + its parents. + + + + + + &man.gbp.config-files; + + + SEE ALSO + + + + gbp-import-dscs + 1 + , + + gbp-buildpackage + 1 + , + + gbp-import-orig + 1 + , + + gbp-dch + 1 + , + + apt-get + 1 + , + + dget + 1 + , + + gbp.conf + &dhconfsection; + , + &man.seealso.common; + + + + AUTHOR + + &dhusername; &dhemail; + + + diff --git a/docs/manpages/gbp-import-dscs.sgml b/docs/manpages/gbp-import-dscs.sgml new file mode 100644 index 00000000..b494e294 --- /dev/null +++ b/docs/manpages/gbp-import-dscs.sgml @@ -0,0 +1,112 @@ + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + + gbp-import-dscs + &dhsection; + + + git-import-dscs + gbp-import-dscs + Import multiple versions of a Debian source packages into a Git repository + + + + &gbp-import-dscs; + + + pkg_1.dsc + pkg_2.dsc + ... + + + or + + + &gbp-import-dscs; + --debsnap + + + package + + + + DESCRIPTION + + &gbp-import-dscs; imports several versions of a Debian source package into + a &git; repository. To do so it sorts the packages by their versions first + and then imports them via calling &gbp-import-dsc; on each package. + + + + If the current directory isn't a &git; repository already the repository is + created in a subdir of the current working directory, named after the first + imported package, otherwise the &git; repository in the current working + directory is being used. This allows for incremental imports. + + + + OPTIONS + + + + + + Fetch snapshots from snapshots.debian.org using debsnap. + + + + + + + Ignore gbp.conf files stored in the git +repository itself. This can be useful to ignore branch informations and other +options shipped in the package source. + + + + + All other options are passed on verbatim to &gbp-import-dsc;. + + + + SEE ALSO + + + + gbp-import-dsc + 1 + , + + gbp-buildpackage + 1 + , + + gbp-import-orig + 1 + , + + gbp-dch + 1 + , + + gbp.conf + &dhconfsection; + , + &man.seealso.common; + + + + AUTHOR + + &dhusername; &dhemail; + + + diff --git a/docs/manpages/gbp-import-orig.sgml b/docs/manpages/gbp-import-orig.sgml new file mode 100644 index 00000000..2a2e015c --- /dev/null +++ b/docs/manpages/gbp-import-orig.sgml @@ -0,0 +1,239 @@ + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + + gbp-import-orig + &dhsection; + + + git-import-orig + gbp-import-orig + Import an upstream source into a git repository + + + + &gbp-import-orig; + + + version + + branch_name + branch_name + tag_name + + gpg-keyid + tag-format + pattern + + + + + + + upstream-source + + + + + + DESCRIPTION + + &gbp-import-orig; imports upstream-source into + the &git; repository. upstream-source can either + be a gzip, bzip2, lzma or xz compressed tar archive, a zip archive or an + already unpacked source tree. If it is already of the form + package-name_version.orig.tar.gz, the version + information is read from the tarball's filename otherwise it can be + given on the command line via . + If the source package name or version can't be determined + &gbp-import-orig; will prompt for it unless + is given. + + The sources are placed on the upstream branch (default: + upstream), tagged and merged onto the debian + branch (default: master). + + + + OPTIONS + + + + =version + version + + The upstream version number + + + + + + Merge the upstream branch to the debian branch after import + + + + + =branch_name + + + The branch in the Git repository the upstream sources are put + onto. Default is upstream. + + + + =branch_name + + + The branch in the Git repository the Debian package is being + developed on, default is master. After + importing the new sources on the upstream branch, &gbp-import-orig; + will try to merge the new version onto this branch. + + + + =tag_name + + + + Add tag_name as additional parent to the commit + of the upstream tarball. Useful when upstream uses git and you want to + link to it's revision history. + + + + + + + + verbose execution + + + + + + + GPG sign all created tags + + + + gpg-keyid + + + use this keyid for gpg signing tags + + + + tag-format + + + use this tag format when tagging upstream versions, + default is upstream/%(version)s + + + + msg-format + + + use this format string for the commit message when + importing upstream versions, default is Imported + Upstream version %(version)s + + + + pattern + + + filter out files glob-matching pattern. Can be given multiple times. + + + + + + + generate pristine-tar delta file + + + + + + + if using a filter also filter the files out of the tarball + passed to pristine-tar + + + + + + + Whether to create and keep a symlink from the upstream tarball + to a Debian policy conformant upstream tarball name located in + ../. + + + This is a good idea if not using pristine-tar + since it avoids creating a new tarball with a different md5sum. + + + + + + + run cmd after the import. + + + + + + Use uscan to fetch new upstream version. + + + + + + &man.gbp.config-files; + + + SEE ALSO + + + + gbp-buildpackage + 1 + , + + gbp-import-dsc + 1 + , + + gbp-import-dscs + 1 + , + + gbp-dch + 1 + , + + gbp.conf + &dhconfsection; + , + &man.seealso.common; + + + + + AUTHOR + + &dhusername; &dhemail; + + + + + diff --git a/docs/manpages/gbp-pull.sgml b/docs/manpages/gbp-pull.sgml index 282ced41..b1a36304 100644 --- a/docs/manpages/gbp-pull.sgml +++ b/docs/manpages/gbp-pull.sgml @@ -132,7 +132,7 @@ - &man.git.config-files; + &man.gbp.config-files; SEE ALSO diff --git a/docs/manpages/gbp.sgml b/docs/manpages/gbp.sgml index 7376edab..c2400b1f 100644 --- a/docs/manpages/gbp.sgml +++ b/docs/manpages/gbp.sgml @@ -131,7 +131,7 @@ - &man.git.config-files; + &man.gbp.config-files; SEE ALSO diff --git a/docs/manpages/git-buildpackage.sgml b/docs/manpages/git-buildpackage.sgml deleted file mode 100644 index 4660f5f4..00000000 --- a/docs/manpages/git-buildpackage.sgml +++ /dev/null @@ -1,489 +0,0 @@ - - -
- &dhemail; -
- - &dhfirstname; - &dhsurname; - - - - gbp-buildpackage - &dhsection; - - - git-buildpackage - gbp-buildpackage - Build Debian packages from a Git repository - - - - &gbp-buildpackage; - - - - [auto|on|off] - [auto|on|off] - treeish - branch_name - - BUILD_CMD - CLEAN_CMD - - - DIST - ARCH - - - - gpg-keyid - command - command - command - command - - tag-format - tag-format - - - [TAG|BRANCH|treeish] - directory - type - level - directory - treeish - - - - - - - - - - DESCRIPTION - - &gbp-buildpackage; is used to build Debian source and .deb packages from a &git; repository. - - - &gbp-buildpackage; will, in order: - - - Verify that it is being executed from the - proper location. - - Verify that the repository doesn't contain any - uncommitted source changes. - - Verify that it is being executed from the - correct branch. - - - (Optionally) export the source tree to a separate build area - - Build an orig tarball if it doesn't exist. - - Call debuild(1) - (or the application specified via ) - with arguments instructing it to ignore &git; meta-data in - the diff.gz, passing along all arguments given to - &gbp-buildpackage; that don't start with --git-. - - - - (Optionally) tag the tree after a successful build - - - (Optionally) call a post build hook - e.g. to run &lintian; - - - (Optionally) call a post tag hook - e.g. to push the results to a remote - repository after creating the tag - - - - - OPTIONS - - - - - - - Don't abort if there are uncommitted changes in the source tree - or the current branch doesn't match the - debian-branch. - - - - - - - Add a git tag after a successful build. - - - - - - Use BUILD_CMD instead of debuild -i -I - - - - - - Use CLEAN_CMD instead of debuild clean - - - - - - Build package using git-pbuilder. Note that - this overwrites any and - options. - - - - - - Build package using git-pbuilder with - qemubuilder. Note that this overwrites any - and - options. - - - - - - Build for distribution DIST when - using --git-pbuilder. If unset build for the - unstable distribution. - - - - - - Build for architecture ARCH when - using --git-pbuilder. If unset no architecture is - passed to git-pbuilder. - - - - - - Whether to try to autoconfigure - git-pbuilder or to rely on the settings in - .pbuilderrc. See the git-pbuilder - manpage for details. - - - - - Options to pass to pbuilder - - - - - - - verbose execution - - - - [auto|on|off] - - - Whether to use colored output. - - - - [auto|on|off] - - - Whether to send a desktop notification after the build. - - - - =branch_name - - - Branch to build the orig tarball from if - is set to BRANCH. Default is - upstream. - - - - =branch_name - - - If you're not on this branch when invoking &gbp-buildpackage; - it will fail. Default is master. This is - done to make sure you don't accidentally release from a topic branch. - Not being on this branch will be ignored when using - . - - - - - - - - Don't check if the current branch matches - debian-branch. - - - - - - - GPG sign all created tags - - - - gpg-keyid - - - use this keyid for gpg signing tags - - - - command - - - excecute command after tagging a new - version.Exported environment variables are: - GBP_TAG (the name of the generated tag), - GBP_BRANCH (the branch the package was build from) and - GBP_SHA1 (the sha1 of the commit the tag was created - at). - - - - command - - - execute command after successful - build. Exported environment variables are: - GBP_CHANGES_FILE (the name of the generated changes - file), GBP_BUILD_DIR (the build dir). - - - - command - - - execute command after exporting the source - tree - valid only if --git-export-dir has been specified. - Exported environment variables are: - GBP_GIT_DIR (the repository the package is being built - from), GBP_TMP_DIR (the temporary directory where the - sources have been initially exported). - - - - command - - - execute command from the build - directory before calling debuild - or the application specified via . - Exported environment variables are: - GBP_GIT_DIR (the repository the package is being built from), - GBP_BUILD_DIR (the build dir). - - - - - - Enable running all (cleaner, postexport, prebuild, postbuild, - and posttag) hooks. Note: the command is - not affected by this option. - - - - tag-format - - - use this tag format when tagging Debian versions, - default is debian/%(version)s - - - - tag-format - - - use this tag format when looking for tags of upstream versions, - default is upstream/%(version)s. - - - - - - - Force creation of an orig tarball (overwriting a pre-existing one if present) - - - - - - - Don't try to create any orig tarball - - - - - - - Extract orig tarball when using export-dir option (analog to mergeWithUpstream in svn-bp) - - - - directory - - - Export the current branch head (or the treeish object given via - to directory - before building. - - - - treeish - - - Instead of exporting the current branch head, export the - treeish object treeish. The special name - INDEX exports the current index whereas - the special name WC exports the current working - copy as is. - - - - [tag|branch] - - - How to find the upstream sources used to generate the tarball. - TAG looks at a tag corresponding to the - version in the changelog. BRANCH looks at - the upstream branch given via the - option. Other values are interpreted as treeishs. - - This doesn't have any effect if - is being used. - - - - - directory - - - Search for original tarballs in directory instead of generating them - - - - type - - - Specifies the upstream tarball compression type. This will be - used to locate and build the upstream tarball if necessary. The - default is auto which derives the - compression type from the pristine-tar branch if available and falls - back to gzip otherwise. Other options are - gzip, bzip2, - lzma and xz. - - - - - level - - - Specifies the upstream tarball compression level if an upstream tarball needs to be built. - - - - - - - Purge (remove) temporary build directory after build - - - - - - - Deprecated, use --git-no-purge instead. - - - - - - - don't build, only tag and run post-tag hooks - - - - - - - don't fail tag operations if a tag with the same version - already exists - - - - - - - Use pristine-tar when generating the upstream tarball if it doesn't exist. - - - - - - - Commit the pristine-tar delta to the pristine-tar branch if a new tarball was - generated and the pristine-tar data isn't already there. - - - - - - &man.git.config-files; - All options in the config files are specified without the 'git-' prefix. - - - SEE ALSO - - - gbp-import-dsc - 1 - , - - gbp-import-dscs - 1 - , - - gbp-import-orig - 1 - , - - gbp-dch - 1 - , - - git-pbuilder - 1 - , - - gbp.conf - &dhconfsection; - - &man.seealso.common; - - - - AUTHOR - - &dhusername; &dhemail; - - - diff --git a/docs/manpages/git-dch.sgml b/docs/manpages/git-dch.sgml deleted file mode 100644 index 7e550f37..00000000 --- a/docs/manpages/git-dch.sgml +++ /dev/null @@ -1,441 +0,0 @@ - - -
- &dhemail; -
- - &dhfirstname; - &dhsurname; - - - - gbp-dch - &dhsection; - - - git-dch; - gbp-dch; - Generate the Debian changelog from git commit messages - - - - &gbp-dch; - - - branch_name - tag-format - tag-format - - - - - - - - commitish - - version - - - - - - - name - - level - - - - expression - number - git-log-options - - - - - msg-format - - customization-file - [path1 path2] - - - - DESCRIPTION - - &gbp-dch; reads git commit messages and generates the Debian changelog from - it. If no arguments are given &gbp-dch; 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 - 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 - 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. - - The additional path arguments can be used to restrict the repository paths - &gbp-dch; looks at. Setting path to - debian/ is a good choice if upstream uses &git; and - 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". - - - OPTIONS - - - - =branch_name - - - 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. - - - - - - - verbose execution - - - - tag-format - - - tag format used, when tagging debian versions, - default is debian/%(version)s - - - - 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). - - - - - - - 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. - - - - - - 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. - - - - expression - - - 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. - - - - version, - version - - - Add a new changelog section with version - newversion. Together with - the snapshot number will be appended to - newversion. - - - - - - 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 a non-maintainer upload. - - - - - - - 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. - - - - - - - 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. - - - - git-log-options - - - 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. - - - - regex - - - Ignore commit lines matching regex - when generating the changelog. - - - - - - - - Use user.name and user.email from git-config(1) for changelog trailer. - - - - - - - Merge commits by maintainer. - - - - - - - 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 - - - - - - - Commit the generated changelog. - - - - - - 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 - 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 - the option. The tags must start at the first column of - a commit message but can appear on any line. - They are of the form : - value. Valid Meta Tags are: - - - - : 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. - - - - - The following git commit message: - - Document meta tags - - so one doesn't have to consult the manual - - Git-Dch: Short - Closes: #636088 - Thanks: Raphaël Hertzog for the suggestion - - - Results in this debian/changelog entry: - - - * Document meta tags. - Thanks to Raphaël Hertzog for the suggestion (Closes: #636088) - - - - &man.git.config-files; - - - SEE ALSO - - - - gbp-buildpackage - 1 - , - - gbp-import-dsc - 1 - , - - gbp-import-dscs - 1 - , - - gbp-import-orig - 1 - , - - gbp.conf - &dhconfsection; - , - &man.seealso.common; - - Cl2vcs, - - - - AUTHOR - - &dhusername; &dhemail; - - - diff --git a/docs/manpages/git-import-dsc.sgml b/docs/manpages/git-import-dsc.sgml deleted file mode 100644 index 221288fc..00000000 --- a/docs/manpages/git-import-dsc.sgml +++ /dev/null @@ -1,221 +0,0 @@ - - -
- &dhemail; -
- - &dhfirstname; - &dhsurname; - - - - gbp-import-dsc - &dhsection; - - - git-import-dsc - gbp-import-dsc - Import Debian packages into a Git repository - - - - &gbp-import-dsc; - - - branch_name - branch_name - - gpg-keyid - tag-format - tag-format - pattern - - - - - - debian-source.dsc - - - &gbp-import-dsc; - - - - - - URL - source-package - - - - - DESCRIPTION - - &gbp-import-dsc; imports a Debian source package into a &git; repository, - notes the package version in the commit logs, and commits the change. All - information, including package name, version, Debian diffs, and upstream - source is automatically detected from the source package. - - - - OPTIONS - - - - =branch_name - - - The branch in the &git; repository the upstream sources are put - onto. Default is upstream. - - - - =branch_name - - - The branch in the &git; repository the debian sources are put - onto. Default is master. - - - - - - - verbose execution - - - - - - - GPG sign all created tags - - - - gpg-keyid - - - use this keyid for gpg signing tags - - - - tag-format - - - use this tag format when tagging Debian versions, - default is debian/%(version)s - - - - tag-format - - - use this tag format when tagging upstream versions, - default is upstream/%(version)s - - - - pattern - - - filter out files glob-matching pattern. Can be given multiple times. - - - - - - - generate pristine-tar delta file - - - - - - - Download the source package instead of looking for it in the local - file system. The argument can either be a - source-package name or an - URL. The former uses &apt-get; to download - the source while the later uses &dget;. - - - - - - - - Whether to skip signature verification on downloads. - - - - - - - Allow to import a package with the same debian version. - - - - - - - When importing the Debian patch, use the author identity as - comitter identity. - - - - - - - When importing the Debian patch, use the author date as - comitter date. Git will subtly misbehave if the - committer date of a commit is not later than or equal to all - its parents. - - - - - - &man.git.config-files; - - - SEE ALSO - - - - gbp-import-dscs - 1 - , - - gbp-buildpackage - 1 - , - - gbp-import-orig - 1 - , - - gbp-dch - 1 - , - - apt-get - 1 - , - - dget - 1 - , - - gbp.conf - &dhconfsection; - , - &man.seealso.common; - - - - AUTHOR - - &dhusername; &dhemail; - - - diff --git a/docs/manpages/git-import-dscs.sgml b/docs/manpages/git-import-dscs.sgml deleted file mode 100644 index b494e294..00000000 --- a/docs/manpages/git-import-dscs.sgml +++ /dev/null @@ -1,112 +0,0 @@ - - -
- &dhemail; -
- - &dhfirstname; - &dhsurname; - - - - gbp-import-dscs - &dhsection; - - - git-import-dscs - gbp-import-dscs - Import multiple versions of a Debian source packages into a Git repository - - - - &gbp-import-dscs; - - - pkg_1.dsc - pkg_2.dsc - ... - - - or - - - &gbp-import-dscs; - --debsnap - - - package - - - - DESCRIPTION - - &gbp-import-dscs; imports several versions of a Debian source package into - a &git; repository. To do so it sorts the packages by their versions first - and then imports them via calling &gbp-import-dsc; on each package. - - - - If the current directory isn't a &git; repository already the repository is - created in a subdir of the current working directory, named after the first - imported package, otherwise the &git; repository in the current working - directory is being used. This allows for incremental imports. - - - - OPTIONS - - - - - - Fetch snapshots from snapshots.debian.org using debsnap. - - - - - - - Ignore gbp.conf files stored in the git -repository itself. This can be useful to ignore branch informations and other -options shipped in the package source. - - - - - All other options are passed on verbatim to &gbp-import-dsc;. - - - - SEE ALSO - - - - gbp-import-dsc - 1 - , - - gbp-buildpackage - 1 - , - - gbp-import-orig - 1 - , - - gbp-dch - 1 - , - - gbp.conf - &dhconfsection; - , - &man.seealso.common; - - - - AUTHOR - - &dhusername; &dhemail; - - - diff --git a/docs/manpages/git-import-orig.sgml b/docs/manpages/git-import-orig.sgml deleted file mode 100644 index e8ce68e7..00000000 --- a/docs/manpages/git-import-orig.sgml +++ /dev/null @@ -1,239 +0,0 @@ - - -
- &dhemail; -
- - &dhfirstname; - &dhsurname; - - - - gbp-import-orig - &dhsection; - - - git-import-orig - gbp-import-orig - Import an upstream source into a git repository - - - - &gbp-import-orig; - - - version - - branch_name - branch_name - tag_name - - gpg-keyid - tag-format - pattern - - - - - - - upstream-source - - - - - - DESCRIPTION - - &gbp-import-orig; imports upstream-source into - the &git; repository. upstream-source can either - be a gzip, bzip2, lzma or xz compressed tar archive, a zip archive or an - already unpacked source tree. If it is already of the form - package-name_version.orig.tar.gz, the version - information is read from the tarball's filename otherwise it can be - given on the command line via . - If the source package name or version can't be determined - &gbp-import-orig; will prompt for it unless - is given. - - The sources are placed on the upstream branch (default: - upstream), tagged and merged onto the debian - branch (default: master). - - - - OPTIONS - - - - =version - version - - The upstream version number - - - - - - Merge the upstream branch to the debian branch after import - - - - - =branch_name - - - The branch in the Git repository the upstream sources are put - onto. Default is upstream. - - - - =branch_name - - - The branch in the Git repository the Debian package is being - developed on, default is master. After - importing the new sources on the upstream branch, &gbp-import-orig; - will try to merge the new version onto this branch. - - - - =tag_name - - - - Add tag_name as additional parent to the commit - of the upstream tarball. Useful when upstream uses git and you want to - link to it's revision history. - - - - - - - - verbose execution - - - - - - - GPG sign all created tags - - - - gpg-keyid - - - use this keyid for gpg signing tags - - - - tag-format - - - use this tag format when tagging upstream versions, - default is upstream/%(version)s - - - - msg-format - - - use this format string for the commit message when - importing upstream versions, default is Imported - Upstream version %(version)s - - - - pattern - - - filter out files glob-matching pattern. Can be given multiple times. - - - - - - - generate pristine-tar delta file - - - - - - - if using a filter also filter the files out of the tarball - passed to pristine-tar - - - - - - - Whether to create and keep a symlink from the upstream tarball - to a Debian policy conformant upstream tarball name located in - ../. - - - This is a good idea if not using pristine-tar - since it avoids creating a new tarball with a different md5sum. - - - - - - - run cmd after the import. - - - - - - Use uscan to fetch new upstream version. - - - - - - &man.git.config-files; - - - SEE ALSO - - - - gbp-buildpackage - 1 - , - - gbp-import-dsc - 1 - , - - gbp-import-dscs - 1 - , - - gbp-dch - 1 - , - - gbp.conf - &dhconfsection; - , - &man.seealso.common; - - - - - AUTHOR - - &dhusername; &dhemail; - - - - - diff --git a/docs/manpages/manpages.ent b/docs/manpages/manpages.ent index f305b303..3aee1def 100644 --- a/docs/manpages/manpages.ent +++ b/docs/manpages/manpages.ent @@ -1,13 +1,13 @@ - - - - - + + + + + - + diff --git a/docs/manual.sgml b/docs/manual.sgml index 5db1a15b..529f8109 100644 --- a/docs/manual.sgml +++ b/docs/manual.sgml @@ -28,11 +28,11 @@ Command Reference &man.gbp; - &man.git.buildpackage; - &man.git.importdsc; - &man.git.importdscs; - &man.git.importorig; - &man.git.dch; + &man.gbp.buildpackage; + &man.gbp.importdsc; + &man.gbp.importdscs; + &man.gbp.importorig; + &man.gbp.dch; &man.gbp.clone; &man.gbp.pull; &man.gbp.pq; -- cgit v1.2.3