How to report a bug

First off, if you need to report a bug please remember that your report is invaluable to us and to the open source community as a whole, testing from users will help the mutt developers in creating a better software; the following pieces of information are useful to integrate the default debian policy when submitting bugs, as usual you can use reportbug(1).

Severity

The severity is based on what the Debian Policy says, very shortly: if the package does not build the bug is 'serious', if it is segfaulting or corrupting your data we would like the bug to be 'important', if it is a standard bug feel free to use 'normal', if it's a feature you would like to see in the future version of mutt please use 'wishlist'.

Independently from the severity all the bugs will be fixed/forwarded usptream, very rarely we decide that a bug is a 'wontfix'.

Data we would like to get

If it is a normal bug, we would like to know the precise steps to reproduce it, that means:

  1. the smallest .muttrc needed to reproduce the bug
  2. the list of steps needed to reproduce it (for example: 1) open mutt 2) select a message and click enter 3) hit "c?" and write etc etc)
  3. your .muttdebug0, that is generated by launching mutt with the -d5 option

Again: smallest .muttrc, list of steps needed to reproduce it, and if possible a .muttdebug0. Usually muttdebug and .muttrc are not needed because the bugs are very easy to reproduce, but sometimes, when we cannot reproduce it, we need to figure out what is going on, so we need these files. If you are going to send us these files please see the paragraph below about how to protect your own privacy.

If it is an important bug, especially if your mutt is crashing and segfaulting, we absolutely need all things I wrote above and the bzip2-ed corefile; usually mutt does not generate a corefile because your shell is not allowing it to do so, so before launching mutt -d5 you need to type ulimit -c unlimited so your shell won't limit the size of the corefile generated; then once mutt crashes the corefile will be in your home directory

If mutt does not crash but it just hangs and you know how to reproduce it please send us the instruction, we would also like to get a corefile, to do so please do the following steps:

  1. ulimit -c unlimited <enter>

  2. gdb /usr/bin/mutt <enter>

  3. (gdb) set args -d5 <enter>

  4. (gdb) run <enter>

  5. mutt will start, do the minimal amount of things needed to let it hang
  6. once mutt hangs hit Ctrl+C and you will get the gdb prompt
  7. (gdb) generate-core-file <enter>

Then the corefile will be generated and you can send it to us

Protect your own privacy before sending us the data

The following file could contain info about you or your mail account:

  1. muttdebug0 (username/password)
  2. .muttrc (username/password, it depends on your conf)
  3. corefile

Especially the corefile could contain some mail which are left in memory or even your password or other info about your connection. So please remember to change your password before or after sending the corefile to us. If you are really paranoid about your privacy we suggest to use a test account and try to reproduce the bug against that test account

Fowarding bugs

We will take care of making contact with upstream to notify them about your bug, they are very responsive, sometimes we even offer patches to fix it, so don't bother opening the bug upstream because we will do so (after a little bit of investigation). Please remember that once your bug is forwarded the discussion, if any, will continue on the upstream ticket, so if you think that your bug could need additional explanation or justification (for example if it's a feature request), remember to subscribe the debian bug, you will receive updates from it.

If upstream will ask you to do some test or if they want more information, we will let you know by tagging the Debian bug as moreinfo and send you a mail.


Developer information

Repository: http://git.debian.org/?p=pkg-mutt/mutt.git

Alioth project: http://alioth.debian.org/projects/pkg-mutt

Upstream trac: http://dev.mutt.org/trac/

Bts-link is watching the upstream trac. Bugs should be marked as forwarded to http://dev.mutt.org/trac/ticket/nnnn. The old http://bugs.mutt.org/nnnn also works.

BTS usercategory

There is a BTS view to group bugs by user tags: http://bugs.debian.org/cgi-bin/pkgreport.cgi?src=mutt&ordering=mutt-sort&pend-exc=done

Current setting:

user mutt@packages.debian.org

usercategory mutt-tag
 * Mutt tag [tag=]
  + Debian specific patch [debian-specific]
  + Debian configuration [debian-config]
  + IMAP and POP3 [imap]
  + Local folder-related [folder]
  + Header-cache [header-cache]
  + Lockfiles and temp file creation [lock]
  + Message rendering and index/pager [display]
  + Charset handling [charset]
  + MIME parsing and attachments handling [mime]
  + GPG and SMIME [crypt]
  + Documentation [doc]
  + General upstream [upstream-bug]
  + Wishlist items for upstream [upstream-wishlist]
  + Requests for new feature [new-feature]
  + Uncategorized []

usercategory mutt-sort
 * mutt-tag
 * status
 * severity

thanks