diff options
| author | Guido Günther <agx@sigxcpu.org> | 2013-08-22 10:47:15 +0200 |
|---|---|---|
| committer | Guido Günther <agx@sigxcpu.org> | 2013-08-22 10:47:15 +0200 |
| commit | 388cfb8fa9912f63168e6150a940e3a0f4cd71ed (patch) | |
| tree | 46b01ee019780978f7656a51a6d1c630a4a4d5c6 /docs | |
| parent | d0fb6d86201d04fb9194119239ccc212302a1b6f (diff) | |
| download | git-buildpackage-388cfb8fa9912f63168e6150a940e3a0f4cd71ed.tar.gz git-buildpackage-388cfb8fa9912f63168e6150a940e3a0f4cd71ed.tar.bz2 git-buildpackage-388cfb8fa9912f63168e6150a940e3a0f4cd71ed.zip | |
docs: Add recommended branch layout
It'd be nice to have similar branch layouts among packages so recommend
one that worked well so far.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/chapters/import.sgml | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/docs/chapters/import.sgml b/docs/chapters/import.sgml index ddb38715..231e36c3 100644 --- a/docs/chapters/import.sgml +++ b/docs/chapters/import.sgml @@ -232,6 +232,76 @@ upstream-tag = v%(version)s </sect2> </sect1> + <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> + and a branch to keep the upstream packaging called <emphasis>upstream</emphasis>. + </para> + <para> + This layout is simple to get started but fails short if one needs to maintain several versions of + the package at the same time. Therefore the following layout is recommended: + </para> + + <variablelist> + <varlistentry> + <term> + debian/<release> + </term> + <listitem> + <para> + the Debian packaging for a release <emphasis>jessie</emphasis>, + <emphasis>wheezy</emphasis> or <emphasis>sid</emphasis>, <emphasis>experimental</emphasis>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + upstream/<release> + </term> + <listitem> + <para> + the upstream sources for a release matching one of the above + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + security/<release> + </term> + <listitem> + <para> + security updates for a certain release + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + backports/<release> + </term> + <listitem> + <para> + security updates for a certain release + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + dfsg/<release> + </term> + <listitem> + <para> + the dfsg clean upstream sources in case the cleanup is done via a &git; + merge from upstream to this branch. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + In case &pristine-tar; is being used there will be a single <emphasis>pristine-tar</emphasis> + branch that keeps all binary deltas. + </para> + </sect1> </chapter> <!-- LocalWords: tarballs |