Bug#675337: [mk-build-deps] default equivs README.Debian is confusing

[chrysn]

Package: devscripts
Version: 2.11.7
Severity: minor
File: /usr/bin/mk-build-deps
Tags: patch

packages generated by mk-build-deps use equivs' default README template,
which is tailored to typical hackish equivs builds which are used as
make-believe packages. to quote from it:

----

Please note that this is a crude hack and if thoughtlessly used
might possibly do damage to your packaging system.  And please
note as well that using it is not the recommended way of dealing
with broken dependencies.  Better file a bug report instead.

----

this warning does not apply to mk-build-deps built packages at all, and
will confuse users who are not aware of how it comes together.

as a remedy, mk-build-deps can ship its own README template and instruct
equivs to use it, a single-line patch to the script is attached.  the
template can be installed in a static location, as equivs already has
facilities to fill in @-escaped templates.

for the contents of /usr/share/devscripts/mk-build-deps/README.template,
i'd suggest the following:

----

@packagename@ for Debian


This package has the sole purpose of installing packages required for
building the Debian package indicated by its name; it does so by
depending on these packages:

@depends@

It was generated by the mk-build-deps program from the information in
the Build-Depends field(s) of the source package's debian/control file.

@packagename@ can be safely removed after the package it was created for
is built.  If that breaks anything, a dependency is missing in the
package's Depends field.

----

-- Package-specific info:

--- /etc/devscripts.conf ---

--- ~/.devscripts ---
DSCVERIFY_KEYRINGS=~/.gnupg/debian.gpg
DEBSIGN_KEYID=398D1112D3A4BDE1

-- System Information:
Debian Release: wheezy/sid
  APT prefers unstable
  APT policy: (500, 'unstable'), (1, 'experimental')
Architecture: amd64 (x86_64)

Kernel: Linux 3.3.0-trunk-amd64 (SMP w/2 CPU cores)
Locale: LANG=en_GB.UTF-8, LC_CTYPE=en_GB.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash

Versions of packages devscripts depends on:
ii  dpkg-dev   1.16.3
ii  libc6      2.13-32
ii  perl       5.14.2-11
ii  python     2.7.2-10
ii  python2.6  2.6.7-4
ii  python2.7  2.7.3~rc2-2.1

Versions of packages devscripts recommends:
ii  at                        3.1.13-1
ii  curl                      7.26.0-1
ii  dctrl-tools               2.22
ii  debian-keyring            2012.02.22
ii  dput                      0.9.6.3
ii  dupload                   2.7.0
ii  equivs                    2.0.9
ii  fakeroot                  1.18.3-1
ii  gnupg                     1.4.12-4
ii  libcrypt-ssleay-perl      0.58-1
ii  libjson-perl              2.53-1
ii  libparse-debcontrol-perl  2.005-3
ii  libsoap-lite-perl         0.714-1
ii  liburi-perl               1.60-1
ii  libwww-perl               6.04-1
ii  lintian                   2.5.7
ii  man-db                    2.6.1-2
ii  patch                     2.6.1-3
ii  patchutils                0.3.2-1.1
ii  python-debian             0.1.21
ii  python-magic              5.11-1
ii  sensible-utils            0.0.7
ii  strace                    4.5.20-2.3
ii  unzip                     6.0-6
ii  wdiff                     1.1.1-1
ii  wget                      1.13.4-3
ii  xz-utils                  5.1.1alpha+20110809-3

Versions of packages devscripts suggests:
ii  bsd-mailx [mailx]            8.1.2-0.20111106cvs-1
ii  build-essential              11.5
ii  cvs-buildpackage             <none>
ii  devscripts-el                <none>
ii  gnuplot                      4.6.0-8
ii  libauthen-sasl-perl          <none>
ii  libfile-desktopentry-perl    0.04-3
ii  libnet-smtp-ssl-perl         <none>
ii  libterm-size-perl            <none>
ii  libtimedate-perl             1.2000-1
ii  libyaml-syck-perl            1.20-1
ii  mutt                         1.5.21-5+b1
ii  openssh-client [ssh-client]  1:5.9p1-5
ii  svn-buildpackage             0.8.4
ii  w3m                          0.5.3-8

-- no debconf information

-- 
To use raw power is to make yourself infinitely vulnerable to greater powers.
  -- Bene Gesserit axiom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: readme.patch
Type: text/x-diff
Size: 477 bytes
Desc: not available
URL: <http://lists.alioth.debian.org/pipermail/devscripts-devel/attachments/20120531/b207dc61/attachment.patch>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 836 bytes
Desc: Digital signature
URL: <http://lists.alioth.debian.org/pipermail/devscripts-devel/attachments/20120531/b207dc61/attachment.pgp>