README

   1 This is bug-buddy, a graphical bug reporting tool.
   2
   3 What is it?
   4 ===========
   5
   6 bug-buddy can extract debugging information from a crashed application and
   7 create either a stacktrace or a minidump file to send to the GNOME
   8 bug tracker.
   9
  10 How does it work?
  11 =================
  12
  13 bug-buddy uses gdb to collect the stacktrace from the crashed application,
  14 and google-breakpad to create a minidump if the stacktrace doesn't contain
  15 enough debugging information. Stacktraces are then sent to the GNOME Bugzilla,
  16 while minidumps go to the GNOME Socorro server, where they get filed with the
  17 missing debug information and, if needed, eventually forwarded to Bugzilla.
  18
  19 We also ship a GTK+ module, called gnomebreakpad, that allows bug-buddy to
  20 come up automatically every time a GTK+ application crashes.
  21
  22 Installation
  23 ============
  24
  25 It shouldn't be harder than the usual
  26
  27 ~$ ./configure --prefix=/your/prefix
  28 ~$ make
  29 ~# make install
  30
  31 but there are some things that might be tricky: the gnomebreakpad module
  32 should be installed in your GTK+ modules directory (default is
  33 /usr/lib/gtk-2.0/modules), and GTK+ itself should be told to load that module
  34 every time an application starts.
  35
  36 There are two ways to do that:
  37 - add "gnomebreakpad" to the GTK_MODULES environment variable (this is how it
  38   works in GNOME 2.22 and older, as gnome-session takes care of setting the
  39   variable at startup); this is now deprecated.
  40 - add a boolean "/apps/gnome_settings_daemon/gtk-modules/gnomebreakpad" GConf
  41   key (requires GTK+ 2.14.2 and gnome-settings-daemon 2.24.0 to work properly).
  42   The key is installed by default by bug-buddy, and this method is the
  43   reccomended for GNOME 2.24 or newer.
  44
  45 So, if gnomebreakpad for some reason doesn't seem to work, check the GConf key
  46 or the GTK_MODULES environment variable.
  47
  48 Report Bugs
  49 ===========
  50
  51 A bug reporting tool can have bugs as well, funny isn't it? :-P
  52 Please report your bugs to the GNOME bug tracking system
  53 (http://bugzilla.gnome.org), under the bug-buddy component.
  54
  55 Jacob Berkman  <jberkman@andrew.cmu.edu>
  56 Fernando Herrera <fherrera@novell.com>
  57 Cosimo Cecchi <cosimoc@gnome.org>