diff options
author | Guido Günther <agx@sigxcpu.org> | 2017-08-03 22:56:57 -0300 |
---|---|---|
committer | Guido Günther <agx@sigxcpu.org> | 2017-08-06 22:55:04 -0300 |
commit | cbacdfb40ca35633da06e9e05497ac0fb56cc4f9 (patch) | |
tree | 47498d3592bbe64ea9ef73575abc15f5b6dee7d8 /docs | |
parent | a5f22cbf94b3c51815449594c6d31db24664992e (diff) |
push: new command to push changes in one go
Closes: #733639
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile | 1 | ||||
-rw-r--r-- | docs/common.ent | 1 | ||||
-rw-r--r-- | docs/man.gbp-push.sgml | 11 | ||||
-rw-r--r-- | docs/manpages/gbp-push.sgml | 174 | ||||
-rw-r--r-- | docs/manpages/gbp.sgml | 1 | ||||
-rw-r--r-- | docs/manpages/manpages.ent | 1 | ||||
-rw-r--r-- | docs/manual.sgml | 1 |
7 files changed, 190 insertions, 0 deletions
diff --git a/docs/Makefile b/docs/Makefile index 28a05393..6ad326a3 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -14,6 +14,7 @@ MAN1S = \ gbp-pq \ gbp-pristine-tar \ gbp-pull \ + gbp-push \ gbp-buildpackage-rpm \ gbp-import-srpm \ gbp-pq-rpm \ diff --git a/docs/common.ent b/docs/common.ent index 7ff2ef94..ad882b54 100644 --- a/docs/common.ent +++ b/docs/common.ent @@ -19,6 +19,7 @@ <!ENTITY gbp-pq-import "<command>gbp pq <option>import</option></command>"> <!ENTITY gbp-pq-rebase "<command>gbp pq <option>rebase</option></command>"> <!ENTITY gbp-pq-export "<command>gbp pq <option>export</option></command>"> + <!ENTITY gbp-push "<command>gbp push</command>"> <!ENTITY gbp-pristine-tar "<command>gbp pristine-tar</command>"> <!ENTITY gbp-create-remote-repo "<command>gbp create-remote-repo</command>"> <!ENTITY git-pbuilder "<command>git-pbuilder</command>"> diff --git a/docs/man.gbp-push.sgml b/docs/man.gbp-push.sgml new file mode 100644 index 00000000..430f722f --- /dev/null +++ b/docs/man.gbp-push.sgml @@ -0,0 +1,11 @@ +<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ + <!ENTITY % COMMON SYSTEM "common.ent"> + %COMMON; + <!ENTITY % MANPAGES SYSTEM "manpages/manpages.ent"> + %MANPAGES; +]> + +<reference> +<title>git-buildpackage Manual</title> +&man.gbp.push; +</reference> diff --git a/docs/manpages/gbp-push.sgml b/docs/manpages/gbp-push.sgml new file mode 100644 index 00000000..dfddcb3d --- /dev/null +++ b/docs/manpages/gbp-push.sgml @@ -0,0 +1,174 @@ +<refentry id="man.gbp.push"> + <refentryinfo> + <address> + &dhemail; + </address> + <author> + &dhfirstname; + &dhsurname; + </author> + </refentryinfo> + <refmeta> + <refentrytitle>gbp-push</refentrytitle> + &dhsection; + </refmeta> + <refnamediv> + <refname>gbp-push</refname> + + <refpurpose>Push &debian; packaging changes to a &git; remote</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis> + &gbp-push; + + &man.common.options.synopsis; + <arg><option>--ignore-branch</option></arg> + <arg><option>--debian-branch=</option><replaceable>branch_name</replaceable></arg> + <arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg> + <arg><option>--debian-tag=</option><replaceable>tag-format</replaceable></arg> + <arg><option>--upstream-tag=</option><replaceable>tag-format</replaceable></arg> + <arg><option>--[no-]pristine-tar</option></arg> + <arg><option>--dry-run</option></arg> + <arg><replaceable>repository</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + <refsect1> + <title>DESCRIPTION</title> + <para> + &gbp-push; pushes your local changes to a remote repository. It + is best run after uploading a &debian; package to the archive to + update you &debian-branch;, &upstream-branch;, &pristine-tar; + branch and corresponding tags. It will in order + </para> + <itemizedlist> + <listitem> + <para> + Verify that it is being executed from the &debian-branch;. + </para> + </listitem> + <listitem> + <para> + Determine the debian tag from <filename>debian/changelog</filename> + and add it the list of things to push if the changelog does not indicate + an unreleased package. + </para> + </listitem> + <listitem> + <para> + Determine the upstream tag from <filename>debian/changelog</filename> + and add it to the list of things to push if it's not a native package. + </para> + </listitem> + <listitem> + <para> + Determine if the tags correspond to the branch tips of the corresponding + upstream and debian branches. If so, these branches will be added to the list + of things to push. If not the changes will only be pushed up to the commit + that is referenced by the corresponding tag. + </para> + </listitem> + <listitem> + <para> + Determine if the pristine-tar branch needs to be pushed and if so adds it + to the list of things to push. + </para> + </listitem> + <listitem> + <para> + Finally, if not in dry-run mode, pushes the above changes to the remote side. + </para> + </listitem> + </itemizedlist> + <para> + If a <replaceable>remote</replaceable> is given on the command line + the changes are pushed to the given remote repository. By + default it will push to the current branchs remote and fall + back to <emphasis>origin</emphasis>. + </para> + </refsect1> + <refsect1> + <title>OPTIONS</title> + <variablelist> + &man.common.options.description; + <varlistentry> + <term><option>--ignore-branch</option></term> + <listitem> + <para> + Don't fail if the &debian-branch; does not match the currently checked out + branach and push the current branch instead. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--debian-branch</option>=<replaceable>branch_name</replaceable></term> + <listitem> + <para> + The branch in the Git repository the Debian package is being + developed on. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--debian-tag=</option><replaceable>TAG-FORMAT</replaceable></term> + <listitem> + <para> + Use this tag format when looking for tags corresponding to a &debian; + version. Default is <replaceable>debian/%(version)s</replaceable>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--upstream-branch</option>=<replaceable>branch_name</replaceable></term> + <listitem> + <para> + The branch in the &git; repository the upstream sources are put + onto. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--upstream-tag=</option><replaceable>TAG-FORMAT</replaceable></term> + <listitem> + <para> + Use this tag format when looking for tags of upstream + versions. Default + is <replaceable>upstream/%(version)s</replaceable>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--pristine-tar</option></term> + <listitem> + <para>Whether to update the pristine-tar branch too.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--dry-run</option></term> + <listitem> + <para> + Pass the <option>--dry-run</option> to &gitcmd; <option>push</option>. So don't + push anything, only check if things are pushable. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1> + &man.gbp.config-files; + </refsect1> + <refsect1> + <title>SEE ALSO</title> + <para> + <xref linkend="man.gbp.buildpackage"/, + <xref linkend="man.gbp.clone"/, + <xref linkend="man.gbp.pull"/, + <xref linkend="man.gbp.conf"/ + </para> + </refsect1> + <refsect1> + <title>AUTHOR</title> + + <para>&dhusername; &dhemail;</para> + + </refsect1> +</refentry> diff --git a/docs/manpages/gbp.sgml b/docs/manpages/gbp.sgml index 5425475d..eff89f25 100644 --- a/docs/manpages/gbp.sgml +++ b/docs/manpages/gbp.sgml @@ -164,6 +164,7 @@ <xref linkend="man.gbp.export.orig"/, <xref linkend="man.gbp.create.remote.repo"/, <xref linkend="man.gbp.pull"/, + <xref linkend="man.gbp.push"/, <xref linkend="man.gbp.clone"/, <citerefentry> <refentrytitle>git-pbuilder</refentrytitle> diff --git a/docs/manpages/manpages.ent b/docs/manpages/manpages.ent index f7cf17c5..9415946a 100644 --- a/docs/manpages/manpages.ent +++ b/docs/manpages/manpages.ent @@ -8,6 +8,7 @@ <!ENTITY man.gbp SYSTEM "gbp.sgml"> <!ENTITY man.gbp.pristine.tar SYSTEM "gbp-pristine-tar.sgml"> <!ENTITY man.gbp.pull SYSTEM "gbp-pull.sgml"> +<!ENTITY man.gbp.push SYSTEM "gbp-push.sgml"> <!ENTITY man.gbp.clone SYSTEM "gbp-clone.sgml"> <!ENTITY man.gbp.pq SYSTEM "gbp-pq.sgml"> <!ENTITY man.gbp.create.remote.repo SYSTEM "gbp-create-remote-repo.sgml"> diff --git a/docs/manual.sgml b/docs/manual.sgml index 4b851fed..35809ada 100644 --- a/docs/manual.sgml +++ b/docs/manual.sgml @@ -37,6 +37,7 @@ &man.gbp.clone; &man.gbp.config; &man.gbp.pull; + &man.gbp.push; &man.gbp.pristine.tar; &man.gbp.exportorig; &man.gbp.pq; |