[Reportbug-maint] Bug#759026: Should provide working examples of reportbug.d.o usage

[Eduard Bloch]

Package: reportbug
Version: 6.5.0+nmu1
Severity: minor

Hello,

It's good to have a way to report bugs without relying on external SMTP
services. However, it's really underdocmented, error-prone and
unnecessarily hard to setup.

What I mean? The only hint is the very last paragraph in README.Users.gz
so one has to finde it first. There is no overview/TOC at the start of
this file. The file is also not really wellcomoing, it should start with
an abstract which explains in short what is required in order to report
a bug.

Second, if you read the last part in an unbiased way, you will see that
it's not a howto. It tells you what is not to be done but it doesn't
explain how to make sure that it doesn't happen. For example, it tells
you that X-Debbugs-CC has to be used. Which triggers two questions:
 * do I need to set it in some config file? Or via parameter? (There is no
--header parameter in the manpage, for example)
 * does the programm still try to send a mail Cc: header? If yes, will
   the message be blocked? Or how am I supposed to prevent that?

Ideally, reportbug should ship an example config which the user can just
copy to ~/.reportbugrc and it should just work.

Regards,
Eduard.

-- Package-specific info:
** Environment settings:
DEBEMAIL="blade at debian.org"
DEBFULLNAME="Eduard Bloch"
DEBNAME="Eduard Bloch"
INTERFACE="text"

** /home/ed/.reportbugrc:
reportbug_version "4.10.2"
mode expert
ui text
mutt

-- System Information:
Debian Release: jessie/sid
  APT prefers unstable
  APT policy: (500, 'unstable'), (500, 'testing'), (1, 'experimental')
Architecture: amd64 (x86_64)
Foreign Architectures: i386

Kernel: Linux 3.12.18+ (SMP w/4 CPU cores; PREEMPT)
Locale: LANG=de_DE.UTF-8, LC_CTYPE=de_DE.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/bash

Versions of packages reportbug depends on:
ii  apt               1.0.6
ii  python            2.7.8-1
ii  python-reportbug  6.5.0+nmu1

reportbug recommends no packages.

Versions of packages reportbug suggests:
pn  claws-mail                                 <none>
ii  debconf-utils                              1.5.53
ii  debsums                                    2.0.52+nmu2
ii  dlocate                                    1.02+nmu3
ii  emacs23-bin-common                         23.4+1-4.1+b1
ii  exim4                                      4.84~RC1-3
ii  exim4-daemon-light [mail-transport-agent]  4.84~RC1-3
ii  file                                       1:5.19-1
ii  gnupg                                      1.4.18-2
ii  python-gtk2                                2.24.0-3+b1
pn  python-gtkspell                            <none>
pn  python-urwid                               <none>
ii  python-vte                                 1:0.28.2-5
ii  xdg-utils                                  1.1.0~rc1+git20111210-7.1

Versions of packages python-reportbug depends on:
ii  apt               1.0.6
ii  python            2.7.8-1
ii  python-debian     0.1.22
ii  python-debianbts  1.12
ii  python-support    1.0.15

python-reportbug suggests no packages.

-- no debconf information

-- 
<paddyf> denn Ganneff war mal der channel bot von Jörg Jaspert, einem debian
	devloper