Bug#849120: dgit-maint-merge(7): Use debian/source/patch-header

[Sean Whitton]

On Thu, Dec 22, 2016 at 06:56:05PM +, Sean Whitton wrote:
> Move the sample commands for obtaining a patch queue from README.source
> to debian/source/patch-header.

It also resolves a Lintian tag complaining about the DEP-3 template that
would otherwise be inserted as a patch header.

-- 
Sean Whitton


signature.asc
Description: PGP signature

Bug#849120: dgit-maint-merge(7): Use debian/source/patch-header

[Sean Whitton]

Package: dgit
Version: 2.13
Severity: minor
Tags: patch

Move the sample commands for obtaining a patch queue from README.source
to debian/source/patch-header.

- One documented purpose of README.source is to give steps that must be
  taken to make the source package easily modifiable and buildable.  It
  would be bad publicity for dgit if someone were to think, even for a
  moment, that any extra steps were required -- that's precisely what
  this workflow is trying to avoid!

- Someone who looks at the squashed patch is immediately informed why
  the changes to the upstream source seem unrelated, without having to
  hunt around for additional documentation.

- Having this text in README.source might distract from other more
  important information in the latter file.

-- System Information:
Debian Release: stretch/sid
  APT prefers testing
  APT policy: (900, 'testing')
Architecture: i386 (i686)

Kernel: Linux 4.8.0-2-686-pae (SMP w/2 CPU cores)
Locale: LANG=en_GB.utf8, LC_CTYPE=en_GB.utf8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)

Versions of packages dgit depends on:
ii  apt   1.4~beta2
ii  ca-certificates   20161130
ii  coreutils 8.25-2
ii  curl  7.50.1-1
ii  devscripts2.16.14
ii  dpkg-dev  1.18.15
ii  dput  0.11.0
ii  git [git-core]1:2.10.2-3
ii  git-buildpackage  0.8.7
ii  libdpkg-perl  1.18.15
ii  libjson-perl  2.90-1
ii  liblist-moreutils-perl0.416-1+b1
ii  libperl5.24 [libdigest-sha-perl]  5.24.1~rc4-1
ii  libtext-glob-perl 0.10-1
ii  libtext-iconv-perl1.7-5+b4
ii  libwww-perl   6.15-1
ii  perl  5.24.1~rc4-1

Versions of packages dgit recommends:
ii  openssh-client [ssh-client]  1:7.3p1-5

Versions of packages dgit suggests:
ii  sbuild  0.72.0-2

-- no debconf information

-- 
Sean Whitton
From 520effe3ab6cce664bb8b95d60a541849fd1c391 Mon Sep 17 00:00:00 2001
From: Sean Whitton 
Date: Thu, 22 Dec 2016 18:43:37 +
Subject: [PATCH] dgit-maint-merge(7): Use debian/source/patch-header

Signed-off-by: Sean Whitton 
---
 dgit-maint-merge.7.pod | 6 +-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/dgit-maint-merge.7.pod b/dgit-maint-merge.7.pod
index dc5bfa3..245be4c 100644
--- a/dgit-maint-merge.7.pod
+++ b/dgit-maint-merge.7.pod
@@ -238,7 +238,7 @@ source:
 You don't need to create this file if you are using the version 1.0
 source package format.
 
-=head2 Sample text for README.source
+=head2 Sample text for debian/source/patch-header
 
 It is a good idea to explain how a user can obtain a break down of the
 changes to the upstream source:
@@ -263,6 +263,10 @@ See dgit(1), dgit(7) and dgit-maint-merge(7) for more information.
 
 =back
 
+Alternatively, this text could be added to README.source. However,
+this might distract from more important information present in the
+latter file.
+
 =head1 BUILDING AND UPLOADING
 
 Use B, B, B, and B

signature.asc
Description: PGP signature