SubmittingBugReports

From AWN Wiki

Jump to: navigation, search

Contents

[edit] Submitting Bug Reports

There are normally three types of bug reports:

Each type of report needs different data, so below is an example of what to provide for each type of report:

[edit] Focus

Please focus on one bug or feature per bug report(or Blueprint). There is a policy that is followed to mark bugs without a narrow focus as "won't fix". This policy allows developers to sanely manage the bug triage process.

[edit] Crashes

This is the most severe, and therefore needs as much extra data as possible. The first thing to do is to run Awn in a terminal and see if there is any output (warnings or errors). This alone could solve your problem, and if it doesn't, we need to produce a backtrace.

[edit] Producing a good backtrace

To enable the developers to quickly solve your problem, providing a good backtrace of the crash is essential. Here's how to do it:

  • Make sure you have gdb installed on your system. Also, if you haven't compiled Awn from source, make sure you install the Awn debug packages (normally *-dbg), otherwise the trace won't be much use :-). Among the other -dbg packages for Debian-based distros (including Ubuntu), you should have the following installed: libx11-6-dbg, libglib2.0-0-dbg, libgtk2.0-0-dbg, and libc6-dbg. Depending on the Ubuntu repository you use, there may be a -dbg package available for Awn:
  • In a terminal, do this:
$ gdb avant-window-navigator <ENTER> (takes you to the gdb prompt)
(gdb) run <ENTER> 
< wait until Awn crashes, you'll be taken back to the gdb prompt>
(gdb) bt <ENTER>
< copy and paste the output into the bug report>

In addition to the trace, its normally useful to state your distro (and version), your graphics card + driver version, and finally which compositor you are running (Compiz Fusion, Compiz, Beryl, xfwm4, xcompmgr etc).

See also: Details about backtraces from the Gnome project

[edit] Functionality Problems

This type of bug is usually easy to solve, but providing your distro (and version), your graphics card + driver version, and finally which compositor you are running (Compiz Fusion, Compiz, Beryl, xfwm4, xcompmgr etc). You should also include your desktop environment name and version.

  • Note: If you have a problem with a particular applet not working, you'll need to find the source of the applet and file the bug in the correct place. Most applets will be from the awn-extras project on launchpad, or from the forums. One hint about determining whether warnings come from applets is seeing if the warning/error message has the string "awn-applet-activation" in it. That is the program that loads the applets so that awn can use them.

[edit] Feature Requests

There are two things you can do for this...

  1. File a bug as usual, describing what Awn should do, and why. Normally a developer will either comment and/or set a milestone for the feature.
  2. If the feature is more elaborate, you could always create a blueprint, stating your ideas, reasons, and maybe even implementation ideas.
Personal tools