[Ubuntu Wiki] Update of "UnityFilingBugs" by dbarth

Ubuntu Wiki noreply at ubuntu.com
Wed Feb 9 11:51:23 UTC 2011 

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Ubuntu Wiki" for change notification.

The following page has been changed by dbarth:
http://wiki.ubuntu.com/UnityFilingBugs?action=diff&rev1=12&rev2=13

------------------------------------------------------------------------------
- If you find an issue with Unity, here are some guidelines for filing bugs and providing details to the development team
+ <<Include(Debugging/Header)>>
+ ||<tablestyle="float:right; font-size: 0.9em; width:30%; background:#F1F1ED; background-image: url('https://librarian.launchpad.net/1812570/bugsquad.png'); background-repeat: no-repeat; background-position:  98% 0.5ex; margin: 0 0 1em 1em; padding: 0.5em;"><<TableOfContents>>||
  
- == Different bugs ==
+ = Introduction =
  
- First, we're mostly interested in crashers, features that are not working as expected or integration issues.
+ This page provides guidelines for filing bugs related to Unity, how to provide the debugging information required to analyze the issue, and how to triage Unity bugs.
  
- If you have an issue with the design or the usability of Unity, it's better to contact the design team first before filing a bug against Unity. Or better, tag your bug report as opinion or whishlist, so we'll know who should deal with it.
+ = Filing bugs =
  
- == Where to file bugs? ==
+ == Technical issues ==
  
- You should file bugs against [[http://bugs.launchpad.net/unity|Unity]] in Launchpad.
+ Please use "Report a problem" under Help entry (Help->Report a Bug). You should file bugs against [[http://bugs.launchpad.net/unity|Unity]] in Launchpad.
+ 
+ When a crasher occurs on your system you should automatically see a dialog inviting you to report the issue. If will collect useful information from your system, automatically as well. But here is what you can also add to your bug report to help us confirm the issue more easily:
+  * ...
+  * ...
+  * ...
+ 
+ If the dialog doesn't appear for some reason, see the "advanced" procedure below.
  
  Even if the issue is actually in [[http://bugs.launchpad.net/compiz|Compiz]], it's still worth filing the bug against Unity, and we'll triage things to point to compiz as well. We're working very closely with the Compiz project.
  
- == How to file bugs with apport (easy way)? ==
  
- When a crasher occurs on your system you should get an apport dialog inviting you to report the issue.
+ == Design and usability issues ==
  
+ Because Unity is a user interface, certain problems may be related to usability or design aspects, and not technical aspects. 
+ 
+ In this case, contact the [[http://design.canonical.com/|Design Team]] first before filing a bug against Unity. You can reach us on the ayatana list or on #ayatana on freenode. If the issue is acknowledged, or if you really want to file a bug, then tag it as 'opinion' or 'whishlist', and link the issue to the 'ayatana-design' project. This will follow a different workflow.
+ 
+ = Advanced debugging procedure =
+ 
+ == Stale crashers ==
+ 
- If the dialog doesn't appear for some reason, you can check that a crasher trace has been collected by looking into the {{{/var/crash}}} directory. You should see a filename containing 'compiz'. 
+ If apport did not automatically report the issue, you can check that a crasher trace has been collected by looking into the {{{/var/crash}}} directory. You should see a filename containing 'compiz'. 
  
  {{{ls -altr /var/crash}}} to list them in chronological order.
  
- To manually trigger a bug report:
+ To manually create a bug report:
   * stay in your current X session
   * add a window manager from a TTY if needed, ie CTRL-ALT-F1, login, {{{DISPLAY=:0 metacity --replace}}}
   * then, from your X session, do: {{{apport-bug -c /var/crash/<compiz crash file>}}} and follow the procedure in the web page that should open shortly after you invoke this command. Note that focus issues may prevent the page to appear on the top, but look for a new browser window opened in your workspace.
  
- == How to file bugs without apport (hard way)? ==
+ == Getting a stack trace ==
  
  If for some reason apport was not enabled on your system, or if you have a reproducible issue we ask you to investigate, here is how you can generate a stack trace and inspect internal variables.
  
+ Ensure that you have the [[https://wiki.ubuntu.com/DebuggingProgramCrash#Hardy 8.04 and Newer|debugging symbols]] for the compiz, nux and unity packages. 
- == Getting a backtrace ==
- 
- Ensure that you have the [[https://wiki.ubuntu.com/DebuggingProgramCrash#Hardy 8.04 and Newer|debugging symbols]] for the compiz, nux and unity packages. If you want compiz to spit out a backtrace when it crashes, you can grab the crashhandler plugin from [[http://git.compiz.org/compiz/plugins/crashhandler|git]] and enable that in ccsm.
  
  Otherwise, from tty1 (Ctrl + Alt + F1)
  
  {{{
+ $ unity --advanced-debug
- $ export COMPIZ_CONFIG_PROFILE=ubuntu
- $ DISPLAY=:0 gdb compiz
  GNU gdb (GDB) 7.2-ubuntu
  Copyright (C) 2010 Free Software Foundation, Inc.
  License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
@@ -48, +60 @@

  and "show warranty" for details.
  This GDB was configured as "i686-linux-gnu".
  For bug reporting instructions, please see:
- <http://www.gnu.org/software/gdb/bugs/>...
+ <http://www.gnu.org/software/gdb/bugs/>
- Reading symbols from /usr/bin/mutter...(no debugging symbols found)...done.
- (gdb) set args --replace
+ 
+ ...
+ 
- (gdb) set logging file 'compiz.log'
+ (gdb) set logging file 'unity.log'
  (gdb) run
  
- [ and when compiz crashes, do...]
+ [ and when compiz/unity crash, do...]
  
  (gdb) bt full
  
@@ -65, +78 @@

  
  You can also get a valgrind trace by running {{{valgrind compiz --replace &}}} in a terminal. This is a little bit slower to get because it runs compiz under emulation, but it does produce some output which isn't possible to get from gdb.
  
- == Old instructions for the Mutter version on Maverick only (backtrace, the hard way) ==
+ In extreme circumstances, we may ask you to use the crashhandler plugin from [[http://git.compiz.org/compiz/plugins/crashhandler|git]] and enable that in ccsm.
  
- {{{
- $ DISPLAY=:0 gdb mutter
- }}} instead of compiz
  
+ = Triaging instructions =
+ 
+ TBD
+ 
+ = Bug Tags =
+ 
+ These tags allow isolation of bugs into smaller groups, providing an easier and faster way to work on specific issues.
+ 
+ ||<rowbgcolor="#FFEBBB"> '''Tag''' || '''Use case''' ||
+ || [[https://launchpad.net/ubuntu/+source/compiz/+bugs?field.tag=unity|`unity`]] || Compiz bugs which are affecting Unity ||
+ || ... || ... ||
+ 
+ 
+ = Testing a fix =
+ 
+ Sometimes a developer might ask you to test a quick patch he came up with: check the [[https://launchpad.net/~unity/+archive/daily|Daily builds PPA]] to see if an updated version of Unity fixes the bugs you see. Be careful though, as those are daily builds that may break other things, and are to be considered unstable.
+ 
+ = Known bugs =
+ 
+ Known bugs, or missing features, are tracked in Launchpad and assigned to milestones to indicate when it is planned to be fixed and/or released.
+ 
+  * Unity milestones: https://bugs.launchpad.net/unity/+milestones
+   * https://launchpad.net/unity/+milestone/3.4 - ubuntu milestones
+    * https://launchpad.net/unity/+milestone/3.4.4 - weekly milestones
+    * https://launchpad.net/unity/+milestone/3.4.4
+   * https://launchpad.net/unity/+milestone/3.6 
+   * https://launchpad.net/unity/+milestone/3.8
+ 
+ ------
+ '''Also see:'''
+  * DebuggingProcedures
+ 
+ ----
+ CategoryBugSquad CategoryDesktopTeam CategoryDebugging
+

More information about the Ubuntu-bugsquad mailing list