bug-buddy r2721 - trunk

[cosimoc svn gnome org]

Author: cosimoc
Date: Mon Sep 22 11:13:08 2008
New Revision: 2721
URL: http://svn.gnome.org/viewvc/bug-buddy?rev=2721&view=rev

Log:
2008-09-22  Cosimo Cecchi  <cosimoc gnome org>

	* README: update README file with some recent information.


Modified:
   trunk/ChangeLog
   trunk/README

Modified: trunk/README
==============================================================================
--- trunk/README	(original)
+++ trunk/README	Mon Sep 22 11:13:08 2008
@@ -1,4 +1,57 @@
-This is a graphical bug reporting tool.  It can extract debugging
-information from a core file or crashed application (via gnome_segv).
+This is bug-buddy, a graphical bug reporting tool.
 
-Jacob Berkman  <jberkman andrew cmu edu>
\ No newline at end of file
+What is it?
+===========
+
+bug-buddy can extract debugging information from a crashed application and
+create either a stacktrace or a minidump file to send to the GNOME
+bug tracker.
+
+How does it work?
+=================
+
+bug-buddy uses gdb to collect the stacktrace from the crashed application,
+and google-breakpad to create a minidump if the stacktrace doesn't contain
+enough debugging information. Stacktraces are then sent to the GNOME Bugzilla,
+while minidumps go to the GNOME Socorro server, where they get filed with the
+missing debug information and, if needed, eventually forwarded to Bugzilla.
+
+We also ship a GTK+ module, called gnomebreakpad, that allows bug-buddy to
+come up automatically every time a GTK+ application crashes.
+
+Installation
+============
+
+It shouldn't be harder than the usual
+
+~$ ./configure --prefix=/your/prefix
+~$ make
+~# make install
+
+but there are some things that might be tricky: the gnomebreakpad module
+should be installed in your GTK+ modules directory (default is
+/usr/lib/gtk-2.0/modules), and GTK+ itself should be told to load that module
+every time an application starts. 
+
+There are two ways to do that:
+- add "gnomebreakpad" to the GTK_MODULES environment variable (this is how it
+  works in GNOME 2.22 and older, as gnome-session takes care of setting the
+  variable at startup); this is now deprecated.
+- add a boolean "/apps/gnome_settings_daemon/gtk-modules/gnomebreakpad" GConf
+  key (requires GTK+ 2.14.2 and gnome-settings-daemon 2.24.0 to work properly).
+  The key is installed by default by bug-buddy, and this method is the
+  reccomended for GNOME 2.24 or newer.
+
+So, if gnomebreakpad for some reason doesn't seem to work, check the GConf key
+or the GTK_MODULES environment variable.
+
+Report Bugs
+===========
+
+A bug reporting tool can have bugs as well, funny isn't it? :-P
+Please report your bugs to the GNOME bug tracking system
+(http://bugzilla.gnome.org), under the bug-buddy component.
+
+Jacob Berkman  <jberkman andrew cmu edu>
+Fernando Herrera <fherrera novell com>
+Cosimo Cecchi <cosimoc gnome org>