DebuggingCompiz

Differences between revisions 19 and 26 (spanning 7 versions)
Revision 19 as of 2008-08-06 17:00:14
Size: 4199
Editor: localhost
Comment:
Revision 26 as of 2013-06-11 16:00:58
Size: 3518
Editor: racb
Comment: Fix apt-get install syntax
Deletions are marked like this. Additions are marked like this.
Line 4: Line 4:
= Introduction = = How to diagnose =
Line 6: Line 6:
Bugs relating to Compiz typically fall into 4 categories:
 1. Integration bugs - require a detailed description of the issue, steps to reproduce and screen captures where appropriate.
 1. Crasher bugs - Log files from the crash incident are required to track down these.
 1. Hardware specific bugs - The developers may not have access to the hardware that triggers this bug. Certain log files and command outputs can help
 1. Plugin bugs - Sometimes bug reports about a specific plugin will be reported about compiz in general. However, plugins are provided by different packages and the bug should be moved to the right package. Plugins are provided by the packages '''compiz-plugins''', '''compiz-fusion-plugins-main''', and '''compiz-fusion-plugins-extra'''. A reporter may mention a plugin by name based off what it is called in Compiz Config Settings Manager however this doesn't tell you what file to look for in a package. You can determine the plugin name by searching the xml files in /usr/share/compiz/ for what the plugin is called and in that xml file you'll find the plugin name. Using that you can find the right package via dpkg -S <plugin-name>.xml i.e. switcher.
First check if the problem is in a Compiz dependency by upgrading your system to the latest version. Bugs in the video stack (kernel, X and mesa) may appear as Compiz problems.

Try different visual effects settings from the appearance preferences (System -> Preferences -> Appearance -> Visual Effects). If the problem still occurs with effects set to "None" then the problem is no in Compiz but one of the systems mentioned above.

If you have changed the default settings in "!CompizConfig Settings Manager" (package name compizconfig-settings-manager) then try resetting these to the defaults by launching it from from System -> Preferences and clicking on the "Preferences" button and then on the "Reset to defaults" button.

For bugs related to Unity please have a look to [[Unity/FilingBugs]]
Line 14: Line 16:
When reporting a bug about Compiz you should include your '''~/.xsession-errors''' file, '''/var/log/Xorg.0.log''' and the output of '''lspci -vvnn''' as separate attachments to your bug report. If you have confirmed the bug appears to be in compiz file it using the following command:
{{{
ubuntu-bug compiz
}}}
This ensures that all appropriate information about your system is automatically attached to the bug report.
Line 16: Line 22:
Additionally, it would be helpful to know if you can recreate the bug with the default preferences. You can reset the preferences by launching "compiz-config-manager" found in System -> Preferences and labelled Advanced Desktop Effects Settings. Click on the "Preferences" button and then on the "Reset to defaults" button. Please attach screenshots showing the problem in detail.
Line 18: Line 24:
= Bug tags = Describe what occurred and what you expected should have occurred.
Line 20: Line 26:
Compiz provides a variety of plugins for modifying the behavior of your desktop. If the bug is related to a specific plugin it would be helpful to tag it with the plugin name. Indicate if the problem is repeatable and what steps cause it.
Line 22: Line 28:
||<rowbgcolor="#FFEBBB"> '''Tag''' || '''Use case''' ||
|| [[https://launchpad.net/ubuntu/+bugs?field.tag=shift-switcher|`shift-switcher`]] || This bug pertains to the shift-switcher plugin ||
|| [[https://launchpad.net/ubuntu/+bugs?field.tag=application-switcher|`application-switcher`]] || This bug pertains to the application-switcher plugin ||
Indicate if there is a workaround to the problem.
Line 26: Line 30:
= Debugging procedure = Example:
Line 28: Line 32:
Make sure to always include '''~/.xsession-errors''', '''/var/log/Xorg.0.log''', and the output of '''lspci -vvnn'''. The output of lspci will contain information about the video card, identified as "Display controller", that the reporter has which is useful because some bugs are hardware specific. {{{
FancySwitcher does not show all windows.
Line 30: Line 35:
Also try to see if the bug happens with the default settings. To get the default settings, install "compiz-config-manager", launch it and then go to "Preferences" (left bottom corner) and click on the "Reset to defaults" button. To reproduce:
1. Log in
2. Open three GEdit windows
3. Press meta-tab
Line 32: Line 40:
= Known bugs = What occurs:
Only 2 windows are shown in switcher (see attached screenshot with annotations)
Line 34: Line 43:
Description of known issues, how to recognise them and stock responses/actions. What was expected:
All three GEdit windows would be shown in the switcher as occurs when using the standard switcher (alt-tab).
}}}
Line 36: Line 47:
'''Open'''
||<rowbgcolor="#eeeeee"> '''Bug''' || '''Summary''' || '''Symptom''' ||
|| [[https://bugs.launchpad.net/ubuntu/+source/xserver-xorg-video-intel/+bug/147359|147359]] || Intel - 3D artifacts when compiz enabled || When dragging 3D apps, glxgears for example, artifacts are left behind - not a compiz bug ||
= Advanced Debugging =
Line 40: Line 49:
'''Closed'''
||<rowbgcolor="#eeeeee"> '''Bug''' || '''Summary''' || '''Symptom''' ||
|| [[https://bugs.beta.launchpad.net/ubuntu/+source/synaptic/+bug/8896|#8896]] || This bug can be identified by ... || Mark as duplicate of 8896 with the comment "Thank you for reporting. This issue has already been reported as bug #8896. Marking as Duplicate." ||
== Getting a Backtrace ==
Line 44: Line 51:
= Non-bugs = Install the debugging symbol packages (see DebuggingProgramCrash for how to add the debug repository):
{{{
sudo apt-get install compiz-core-dbgsym compiz-plugins-dbgsym compiz-fusion-plugins-main-dbgsym compiz-fusion-plugins-extra-dbgsym compizconfig-backend-gconf-dbgsym libcompizconfig0-dbgsym compiz-gnome-dbgsym
}}}
Line 46: Line 56:
How to recognise common issues arising from hardware failures, common feature requests and other invalid bugs for this category. Advice how triage them and stock responses. {{{
run gdb as:
$ gdb --args compiz --replace
...
(gdb) set logging on compiz-crash.txt
(gdb) run
...
(once it crashes)
...
(gdb) thread apply all bt full
(gdb) set logging off
}}}

Then you can attach that resulting log file (compiz-crash.txt) to the bug report.

== Stale crashers ==

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 file a bug report using a crash file:
 * 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.

Debugging Central

This page is part of the debugging series — pages with debugging details for a variety of Ubuntu packages.

How to diagnose

First check if the problem is in a Compiz dependency by upgrading your system to the latest version. Bugs in the video stack (kernel, X and mesa) may appear as Compiz problems.

Try different visual effects settings from the appearance preferences (System -> Preferences -> Appearance -> Visual Effects). If the problem still occurs with effects set to "None" then the problem is no in Compiz but one of the systems mentioned above.

If you have changed the default settings in "CompizConfig Settings Manager" (package name compizconfig-settings-manager) then try resetting these to the defaults by launching it from from System -> Preferences and clicking on the "Preferences" button and then on the "Reset to defaults" button.

For bugs related to Unity please have a look to Unity/FilingBugs

How to file

If you have confirmed the bug appears to be in compiz file it using the following command:

ubuntu-bug compiz

This ensures that all appropriate information about your system is automatically attached to the bug report.

Please attach screenshots showing the problem in detail.

Describe what occurred and what you expected should have occurred.

Indicate if the problem is repeatable and what steps cause it.

Indicate if there is a workaround to the problem.

Example:

FancySwitcher does not show all windows.

To reproduce:
1. Log in
2. Open three GEdit windows
3. Press meta-tab

What occurs:
Only 2 windows are shown in switcher (see attached screenshot with annotations)

What was expected:
All three GEdit windows would be shown in the switcher as occurs when using the standard switcher (alt-tab).

Advanced Debugging

Getting a Backtrace

Install the debugging symbol packages (see DebuggingProgramCrash for how to add the debug repository):

sudo apt-get install compiz-core-dbgsym compiz-plugins-dbgsym compiz-fusion-plugins-main-dbgsym compiz-fusion-plugins-extra-dbgsym compizconfig-backend-gconf-dbgsym libcompizconfig0-dbgsym compiz-gnome-dbgsym

run gdb as: 
$ gdb --args compiz --replace
...
(gdb) set logging on compiz-crash.txt
(gdb) run
...
(once it crashes)
...
(gdb) thread apply all bt full
(gdb) set logging off

Then you can attach that resulting log file (compiz-crash.txt) to the bug report.

Stale crashers

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 file a bug report using a crash file:

  • 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.


CategoryBugSquad CategoryDebugging

DebuggingCompiz (last edited 2015-09-21 10:08:45 by 3v1n0)