summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorGuido Günther <agx@sigxcpu.org>2017-04-04 07:13:15 +0200
committerGuido Günther <agx@sigxcpu.org>2017-04-12 11:19:09 +0200
commite890ce326ee66e0339ae4c83644473173fc4758e (patch)
tree9eeddd3c212c0b1c1af1ee894363ba973bf10e9a /docs
parent7cfe71d6d45399ded9b50209a2c0dcbf132afd3d (diff)
ipmort_orig: pick best way to import upstream tarball automatically
Add new value --merge-mode=auto that selects either 'replace' or 'merge' depending on the source format version. Closes: #700411
Diffstat (limited to 'docs')
-rw-r--r--docs/chapters/import.sgml18
-rw-r--r--docs/manpages/gbp-import-orig.sgml26
2 files changed, 28 insertions, 16 deletions
diff --git a/docs/chapters/import.sgml b/docs/chapters/import.sgml
index 3ae9e2b6..c401b916 100644
--- a/docs/chapters/import.sgml
+++ b/docs/chapters/import.sgml
@@ -60,10 +60,20 @@ by version number.
This puts the upstream sources onto the <option>upstream-branch</option> and
tags them accordingly (the default tag format is
<replaceable>upstream/%(version)s</replaceable>).
- The result is then merged onto the <option>debian-branch</option>.
- You can again specify different branch names via
- the <option>--upstream-branch</option> and
- <option>--debian-branch</option> options.
+ </para>
+ <para>
+ The result is then placed onto
+ the <option>debian-branch</option>. The way this happens is
+ determined by the <option>--merge-mode</option> option. The
+ default mode <option>auto</option> replaces the upstream sources
+ while preserving the <filename>debian/</filename> directory for
+ 3.0 (quilt) packages. A &git; merge is used for all other source
+ format versions.
+ </para>
+ <para>
+ You can again specify different branch names via
+ the <option>--upstream-branch</option> and
+ <option>--debian-branch</option> options.
</para>
<para>If you are using <filename>debian/watch</filename> to keep track of how to retrieve upstream sources, you can also simply use the <option>--uscan</option> option:
<programlisting>
diff --git a/docs/manpages/gbp-import-orig.sgml b/docs/manpages/gbp-import-orig.sgml
index f6d87a29..f0814d6f 100644
--- a/docs/manpages/gbp-import-orig.sgml
+++ b/docs/manpages/gbp-import-orig.sgml
@@ -23,7 +23,7 @@
&man.common.options.synopsis;
<arg><option>--upstream-version=</option><replaceable>version</replaceable></arg>
<arg><option>--[no-]merge</option></arg>
- <arg><option>--merge-mode=</option><replaceable>[merge|replace]</replaceable></arg>
+ <arg><option>--merge-mode=</option><replaceable>[auto|merge|replace]</replaceable></arg>
<arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg>
<arg><option>--debian-branch=</option><replaceable>branch_name</replaceable></arg>
<arg><option>--upstream-vcs-tag=</option><replaceable>tag-format</replaceable></arg>
@@ -88,16 +88,14 @@
The sources are placed on the upstream branch (default:
<replaceable>upstream</replaceable>), tagged and merged onto the
debian branch (default: <replaceable>master</replaceable>). This
- is either done using <command>git merge</command> in case
- of <option>--merge-mode=</option><replaceable>merge</replaceable>
- (the default) or by creating a new tree that consists of the new
+ 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>
- directory. This behaviour can be enabled via
- the <option>--merge-mode=</option><replaceable>replace</replaceable>
- option and is preferable for source format 3.0 (quilt) packages
- since direct modifications of the upstream sources are not
- allowed in that format and so a 1:1 replacement of the upstream
- sources is almost always desired.
+ directory. The later is used for source format 3.0
+ (quilt) packages since direct modifications of the upstream
+ sources are not allowed in that format and so a 1:1 replacement
+ of the upstream sources is almost always desired. It can
+ be tweaked via the <option>--merge-mode</option>.
</para>
<para>In case of an error &gbp-import-orig; will rollback (undo)
all changes it has done to the repository (see
@@ -127,14 +125,13 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--merge-mode=</option><replaceable>[merge|replace]</replaceable></term>
+ <term><option>--merge-mode=</option><replaceable>[auto|merge|replace]</replaceable></term>
<listitem>
<para>
How to fold the newly imported upstream source to the
&debian; packaging branch after import.
</para>
<para>
- The default mode
<replaceable>merge</replaceable> does a
&git; <command>merge</command> leaving you on your own in
case of merge conflict resolution.
@@ -149,6 +146,11 @@
similar to a <option>theirs</option> merge strategy while
preserving <filename>debian/</filename>.
</para>
+ <para>
+ The default is <replaceable>auto</replaceable> which
+ uses <replaceable>replace</replaceable> for 3.0 (quilt) packages
+ and <replaceable>merge</replaceable> otherwise.
+ </para>
</listitem>
</varlistentry>
<varlistentry>