Skip to content

Commit

Permalink
WIP: Switch default Debian branch to 'debian/latest' (Closes: #829444)
Browse files Browse the repository at this point in the history
As defined by DEP14, the default Debian packaging branch name should be
'debian/latest' instead of 'master.

https://dep-team.pages.debian.net/deps/dep14/
  • Loading branch information
ottok committed Jan 5, 2024
1 parent a653bbf commit ccbc07d
Show file tree
Hide file tree
Showing 52 changed files with 411 additions and 412 deletions.
4 changes: 2 additions & 2 deletions docs/chapters/cfgfile.xml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
# the default branch for upstream sources
upstream-branch=upstream
# the default branch for the debian patch
debian-branch=master
debian-branch=debian/latest

[buildpackage]
upstream-branch=dfsgclean
Expand Down Expand Up @@ -130,7 +130,7 @@
<programlisting>
$ export GBP_CONFI_FILES=/does/not/exist
$ gbp config buildpackage.debian-branch
master
debian/latest
</programlisting>
</para>
</sect1>
Expand Down
10 changes: 5 additions & 5 deletions docs/chapters/import.xml
Original file line number Diff line number Diff line change
Expand Up @@ -119,13 +119,13 @@ by version number.
gbp:info: Importing '../gif2apng-1.9.tar.gz' to branch 'upstream' (filtering out ["'CVS/*'", "'.bzr/*'", "'.hg/*'", "'.svn/*'"])...
gbp:info: Source package is gif2apng
gbp:info: Upstream version is 1.9
gbp:info: Merging to 'master'
gbp:info: Merging to 'debian/latest'
gbp:error: Automatic merge failed.
gbp:error: Error detected, Will roll back changes.
gbp:info: Rolling back branch upstream by resetting it to a6733c1f1e190ac0ed4774abc3466e9986a6df5e
gbp:info: Rolling back branch pristine-tar by resetting it to 0ee24ac614c920e30af82d602882c2ee841c88e5
gbp:info: Rolling back tag upstream/1.9 by deleting it
gbp:info: Rolling back branch master by resetting it to ce99782336e83a56e8e579b3cdadf93b0c19e1a8
gbp:info: Rolling back branch debian/latest by resetting it to ce99782336e83a56e8e579b3cdadf93b0c19e1a8
gbp:info: Rolling back failed merge of upstream/1.9
gbp:error: Rolled back changes after import error.
</programlisting>
Expand Down Expand Up @@ -179,7 +179,7 @@ EOF
&gitcmd; branch upstream $(&gitcmd; log --format='%H' | tail -1)
</programlisting>
The important thing here is that the <envar>COMMIT_ID</envar> specifies a
point on the master branch that carried <emphasis>only</emphasis> the
point on the debian/latest branch that carried <emphasis>only</emphasis> the
upstream sources and not the &debian; modifications. The above example
assumes that this was the first commit to that repository.
</para>
Expand All @@ -200,7 +200,7 @@ EOF
<command>git checkout</command> <option>--orphan</option> <replaceable>upstream</replaceable>
<command>git rm</command> <option>-rf</option> <replaceable>.</replaceable>
<command>git commit</command> <option>--allow-empty</option> <option>-m</option> <replaceable>'Initial upstream branch.'</replaceable>
<command>git checkout</command> <option>-f</option> <replaceable>master</replaceable>
<command>git checkout</command> <option>-f</option> <replaceable>debian/latest</replaceable>
# When not using 3.0 (quilt) with the default --merge-mode=auto
<command>git merge</command> <option>--allow-unrelated-histories</option> <replaceable>upstream</replaceable>
</programlisting>
Expand Down Expand Up @@ -425,7 +425,7 @@ upstream-tag = v%(version%.%_)s
<sect1 id="gbp.branch.naming">
<title>Branch layout</title>
<para>
By default, &gbp; uses one branch to keep the &debian; packaging called <emphasis>master</emphasis>
By default, &gbp; uses one branch to keep the &debian; packaging called <emphasis>debian/latest</emphasis>
and a branch to keep the upstream packaging called <emphasis>upstream</emphasis>.
</para>
<para>
Expand Down
6 changes: 3 additions & 3 deletions docs/chapters/intro.xml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
</para>
<itemizedlist>
<listitem><para>The <option>debian-branch</option> (the default branch
name used in the &git; repository is <emphasis>master</emphasis>) holds
name used in the &git; repository is <emphasis>debian/latest</emphasis>) holds
your current development work. That's the branch you usually cut your
releases from and the default branch new upstream releases are merged
onto.</para></listitem>
Expand All @@ -68,8 +68,8 @@
<listitem><para> There can be one or more <option>patch-queue</option> branches.
Every patch-queue branch is related to a
<option>debian-branch</option>. If the <option>debian-branch</option> is called
<emphasis>master</emphasis>, the corresponding patch-queue branch is
called <emphasis>patch-queue/master</emphasis>. The patch-queue branch is
<emphasis>debian/latest</emphasis>, the corresponding patch-queue branch is
called <emphasis>patch-queue/debian/latest</emphasis>. The patch-queue branch is
the &debian; branch plus the contents of
<emphasis>debian/patches</emphasis> applied. These branches are managed
with &gbp-pq;.
Expand Down
14 changes: 7 additions & 7 deletions docs/chapters/special.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<option>upstream-branch</option> (by default named
<emphasis>upstream</emphasis>) as usual and just don't merge to the
<emphasis>debian-branch</emphasis> (by default named
<emphasis>master</emphasis>):
<emphasis>debian/latest</emphasis>):
</para>
<programlisting>
&gbp-import-orig; --no-merge <filename>/path/to/nondfsg-clean-package_10.4.orig.tar.gz</filename>
Expand All @@ -35,7 +35,7 @@
cleanup-script.sh
&gitcmd; commit -a -m "Make source dfsg clean"
&gitcmd; tag <replaceable>10.4.dfsg</replaceable>
&gitcmd; checkout <replaceable>master</replaceable>
&gitcmd; checkout <replaceable>debian/latest</replaceable>
&gitcmd; pull <replaceable>.</replaceable> <replaceable>dfsg_clean</replaceable>
</programlisting>
</sect1>
Expand All @@ -44,21 +44,21 @@
<title>Importing NMUs</title>
<para>
First, create a branch that holds the NMUs from the tip of your
<option>debian-branch</option> (default is <emphasis>master</emphasis>) once:
<option>debian-branch</option> (default is <emphasis>debian/latest</emphasis>) once:
</para>
<programlisting>
&gitcmd; <option>branch</option> <replaceable>nmu</replaceable> <replaceable>master</replaceable>
&gitcmd; <option>branch</option> <replaceable>nmu</replaceable> <replaceable>debian/latest</replaceable>
</programlisting>
<para>
To import an NMU, change into the git repository and use &gbp-import-dsc;:
</para>
<programlisting>
&gitcmd; checkout <replaceable>master</replaceable>
&gitcmd; checkout <replaceable>debian/latest</replaceable>
&gbp-import-dsc; <option>--debian-branch</option>=<replaceable>nmu</replaceable> <filename>/path/to/package_1.0-1nmu0.dsc</filename>
</programlisting>
<para>
This will import the NMU onto the branched named <emphasis>nmu</emphasis>
instead of the default <option>master</option>. This method can also
instead of the default <option>debian/latest</option>. This method can also
be used to import "old" releases into the &git; repository when migrating
to &git; from another VCS.
</para>
Expand Down Expand Up @@ -151,7 +151,7 @@ EOF
This uses <command>apt-get</command> to download the source package,
puts the orig tarball on the <option>upstream-branch</option> and the
&debian; changes on the <option>debian-branch</option> (by default
<emphasis>master</emphasis>). The second command
<emphasis>debian/latest</emphasis>). The second command
creates a branch called <emphasis>debian</emphasis>. Now you can easily
modify the package, revert changes you made, create other branches for
testing, see what changes you made, etc. When finished, just do</para>
Expand Down
2 changes: 1 addition & 1 deletion docs/manpages/gbp-buildpackage-rpm.xml
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@
<listitem>
<para>
If you're not on this branch when invoking &gbp-buildpackage-rpm; it
will fail. Default is <replaceable>master</replaceable>. This is done
will fail. Default is <replaceable>debian/latest</replaceable>. 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
<option>--git-ignore-new</option>.
Expand Down
2 changes: 1 addition & 1 deletion docs/manpages/gbp-buildpackage.xml
Original file line number Diff line number Diff line change
Expand Up @@ -730,7 +730,7 @@
<listitem>
<para>
If you're not on this branch when invoking &gbp-buildpackage; it will
fail. Default is <replaceable>master</replaceable>. This is done to
fail. Default is <replaceable>debian/latest</replaceable>. 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
<option>--git-ignore-new</option>.
Expand Down
2 changes: 1 addition & 1 deletion docs/manpages/gbp-clone.xml
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
</term>
<listitem>
<para>The branch in the Git repository the Debian package is being
developed on, default is <replaceable>master</replaceable>.</para>
developed on, default is <replaceable>debian/latest</replaceable>.</para>
</listitem>
</varlistentry>
<varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion docs/manpages/gbp-config.xml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
<screen>
$ gbp config buildpackage
buildpackage.upstream-branch=upstream
buildpackage.debian-branch=master
buildpackage.debian-branch=debian/latest
...</screen>
</refsect1>
<refsect1>
Expand Down
2 changes: 1 addition & 1 deletion docs/manpages/gbp-create-remote-repo.xml
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
</term>
<listitem>
<para>The branch in the &git; repository the &debian; package is being
developed on, default is <replaceable>master</replaceable>.</para>
developed on, default is <replaceable>debian/latest</replaceable>.</para>
</listitem>
</varlistentry>
<varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion docs/manpages/gbp-dch.xml
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@
<listitem>
<para>
The branch in the Git repository the Debian package is being
developed on, default is <replaceable>master</replaceable>.
developed on, default is <replaceable>debian/latest</replaceable>.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion docs/manpages/gbp-import-dsc.xml
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
<listitem>
<para>
The branch in the &git; repository the debian sources are put
onto. Default is <replaceable>master</replaceable>.
onto. Default is <replaceable>debian/latest</replaceable>.
</para>
</listitem>
</varlistentry>
Expand Down
4 changes: 2 additions & 2 deletions docs/manpages/gbp-import-orig.xml
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
<para>
The sources are placed on the upstream branch (default:
<replaceable>upstream</replaceable>), tagged and merged onto the
debian branch (default: <replaceable>master</replaceable>). This
debian branch (default: <replaceable>debian/latest</replaceable>). This
is either done using plain <command>git merge</command>
or by creating a new tree that consists of the new
upstream version plus the <filename>debian/</filename>
Expand Down Expand Up @@ -178,7 +178,7 @@
<listitem>
<para>
The branch in the &git; repository the &debian; package is being
developed on, default is <replaceable>master</replaceable>. After
developed on, default is <replaceable>debian/latest</replaceable>. After
importing the new sources on the upstream branch, &gbp-import-orig;
will try to merge the new version onto this branch.
</para>
Expand Down
2 changes: 1 addition & 1 deletion docs/manpages/gbp-import-ref.xml
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@
<listitem>
<para>
The branch in the &git; repository the &debian; package is being
developed on, default is <replaceable>master</replaceable>.
developed on, default is <replaceable>debian/latest</replaceable>.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion docs/manpages/gbp-import-srpm.xml
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
<listitem>
<para>
The branch in the &git; repository the packaging files are put
onto. Default is <replaceable>master</replaceable>.
onto. Default is <replaceable>debian/latest</replaceable>.
</para>
</listitem>
</varlistentry>
Expand Down
4 changes: 2 additions & 2 deletions docs/manpages/gbp-pq-rpm.xml
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@
&gbp-pq-rpm; makes it easy to do source code development on a separate
development branch (patch-queue branch in Debian git-buildpackage terms).
For example, if the packaging files would be stored in
<replaceable>master</replaceable> the associated development branch would
be <replaceable>development/master</replaceable>.
<replaceable>debian/latest</replaceable> the associated development branch would
be <replaceable>development/debian/latest</replaceable>.
</para>
</refsect1>
<refsect1>
Expand Down
4 changes: 2 additions & 2 deletions docs/manpages/gbp-pq.xml
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@
3.0 (quilt) source format. With &gbp-pq;, you can maintain the quilt patches
that should be applied to a package on a separate branch called patch-queue
branch. So if your &debian; package lives on
<replaceable>master</replaceable>, the associated patch-queue branch will be
called <replaceable>patch-queue/master</replaceable>.
<replaceable>debian/latest</replaceable>, the associated patch-queue branch will be
called <replaceable>patch-queue/debian/latest</replaceable>.
</para>
<para>
See <ulink url="https://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.patches.html"></ulink>
Expand Down
2 changes: 1 addition & 1 deletion docs/manpages/gbp-pull.xml
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@
</term>
<listitem>
<para>The branch in the Git repository the Debian package is being
developed on, default is <replaceable>master</replaceable>.</para>
developed on, default is <replaceable>debian/latest</replaceable>.</para>
</listitem>
</varlistentry>
<varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion docs/manpages/gbp-rpm-ch.xml
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@
<listitem>
<para>
The branch in the Git repository the package is being developed on,
default is <replaceable>master</replaceable>.
default is <replaceable>debian/latest</replaceable>.
</para>
</listitem>
</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion docs/manpages/gbp-tag.xml
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@
<listitem>
<para>
If you're not on this branch when invoking &gbp-tag; it will
fail. Default is <replaceable>master</replaceable>. This is done to
fail. Default is <replaceable>debian/latest</replaceable>. This is done to
make sure you don't accidentally tag on the wrong branch. Not
being on this branch will be ignored when using
<option>--ignore-branch</option>.
Expand Down

0 comments on commit ccbc07d

Please sign in to comment.