Mir

Merge lp:~robert-ancell/mir/add_xmir_debug_guide into lp:~kgunn72/mir/add_xmir_debug_guide

Proposed by Robert Ancell
Status: Merged
Merged at revision: 804
Proposed branch: lp:~robert-ancell/mir/add_xmir_debug_guide
Merge into: lp:~kgunn72/mir/add_xmir_debug_guide
Diff against target: 103 lines (+60/-21)
1 file modified
doc/debug_for_xmir.md (+60/-21)
To merge this branch: bzr merge lp:~robert-ancell/mir/add_xmir_debug_guide
Reviewer Review Type Date Requested Status
Alan Griffiths (community) Approve
Daniel Holbach (community) Approve
kevin gunn Pending
Review via email: mp+173385@code.launchpad.net

Commit message

Corrections based on the review

To post a comment you must log in.
Revision history for this message
Daniel Holbach (dholbach) wrote :

Looks good, 'Aleternatively' should be 'Alternatively'.

Just a suggestion: regarding getting more info for a bug report, could we add an apport hook maybe?

review: Approve
Revision history for this message
Alan Griffiths (alan-griffiths) :
review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'doc/debug_for_xmir.md'
2--- doc/debug_for_xmir.md 2013-07-05 18:15:43 +0000
3+++ doc/debug_for_xmir.md 2013-07-07 22:17:26 +0000
4@@ -4,40 +4,79 @@
5 What is XMir ?
6 ----------------
7
8-In order to help with debug, its important to understand what XMir is & what bugs are likely to occur. XMir is not a replacement to X and does not alter X or compiz window management functionality in the current Ubuntu stack. XMir is an addition to the system of Mir being employed as a system compositor under the X stack, effectively compositing the greeter and the desktop session. XMir is currently targeted at the Ubuntu 13.10 release as being the default configuration. It currently supports open source graphics drivers based on Mesa, Nouveau & Radeon. Once XMir is installed and properly configured, upon boot or restart of the lightdm process, XMir will determine if there is proper driver support; in the instance where proprietary drivers not supporting the Mir driver model are detected, it will continue to boot into the standalone X configuration without error. From a visual perspective on Ubuntu desktop, XMir & standalone X are identicle (note, currently there is an X cursor present on Xmir but this soon be disabled, making the experience truly identicle & indescernable without checking on what processes are running, see \ref using_mir_on_pc).
9-
10-
11-How to toggle between XMir & standalone X ?
12+In order to help with debug, its important to understand what XMir is and what
13+bugs are likely to occur. XMir is not a replacement to X and does not alter X or
14+compiz window management functionality in the current Ubuntu stack. XMir is an
15+addition to the system of Mir being employed as a system compositor under the X
16+stack, effectively compositing the greeter and the desktop session. XMir is
17+currently targeted at the Ubuntu 13.10 release as being the default
18+configuration. It currently supports open source graphics drivers based on Mesa,
19+Nouveau and Radeon. Once XMir is installed and properly configured, upon boot or
20+restart of the LightDM daemon, Mir will determine if there is proper driver
21+support; in the instance where proprietary drivers not supporting the Mir driver
22+model are detected, LightDM will continue to boot into the standalone X
23+configuration without error. From a visual perspective on Ubuntu desktop, XMir
24+and standalone X are identical (note, currently there is an X cursor present on
25+XMir but this soon be disabled, making the experience truly identical and
26+indiscernible without checking on what processes are running, see
27+\ref using_mir_on_pc).
28+
29+
30+How to toggle between XMir and standalone X ?
31 -------------------------------------
32
33-In order to return to a standalone X configuration, comment out the following line in /etc/lightdm/lightdm.conf.d/10-unity-system-compositor.conf to look to look like this:
34+In order to return to a standalone X configuration, comment out the following
35+line in /etc/lightdm/lightdm.conf.d/10-unity-system-compositor.conf to look to
36+look like this:
37
38 [SeatDefaults]
39 #type=unity
40
41-Simply reboot or restart lightdm.
42+Simply reboot or restart LightDM.
43 To reverse the process, simply comment the line back in to enable XMir.
44
45 Most common bugs
46 -------------------------------------
47
48-At the moment, the most common bugs are related to failures to boot into XMir. Due to the robust fallback mechanisms in place, you will realize this by booting into a standalone X configuration, when you expected XMir.
49-
50-1. First check your /etc/lightdm/lightdm.conf.d/10-unity-system-compositor.conf has type=unity properly enabled.
51-
52-2. If you desire to log a bug, please include the log files contained in the /var/log/light/ directory. Note, it is good to inspect the last update to these files to see if they were written to in your boot attempt, obviously if they were not updated their contents are irrelevant. The most important of these files is likely the lightdm.log & unity-system-compositor.log. You are more than welcome to inspect these files, frequently there will be an error statment in unity-system-compositor.log which can be traced back into the source code for further debug.
53-
54-3. If you have the experience of booting to a black screen which seems frozen, you may attempt to switch VT's by selecting <Ctrl+Alt+F8> to see if there is a UI present. Aleternatively, <Ctrl+Alt+F1>, login at the console, copy out the log files mentioned above, then toggle back to standalone X as described above & rebooting.
55+At the moment, the most common bugs are related to failures to boot into XMir.
56+Due to the robust fallback mechanisms in place, you will realize this by booting
57+into a standalone X configuration, when you expected XMir.
58+
59+1. First check your /etc/lightdm/lightdm.conf.d/10-unity-system-compositor.conf
60+ has type=unity properly enabled.
61+
62+2. If you desire to log a bug, please include the log files contained in the
63+ /var/log/lightdm/ directory. Note, it is good to inspect the last update to
64+ these files to see if they were written to in your boot attempt, obviously if
65+ they were not updated their contents are irrelevant. The most important of
66+ these files is likely the lightdm.log and unity-system-compositor.log. You
67+ are more than welcome to inspect these files, frequently there will be an
68+ error statment in unity-system-compositor.log which can be traced back into
69+ the source code for further debug.
70+
71+3. If you have the experience of booting to a black screen which seems frozen,
72+ you may attempt to switch VT's by selecting <Ctrl+Alt+F8> to see if there is
73+ a UI present. Aleternatively, <Ctrl+Alt+F1>, login at the console, copy out
74+ the log files mentioned above, then toggle back to standalone X as described
75+ above and rebooting.
76
77 Other bugs
78 -------------------------------------
79
80-If you experience a UI lock up or a crash, it would be helpful to double check for X backtracing which can be found here
81-
82-Note, it is highly unlikely you will see any visual corruption due to XMir. If you experience a visual corruption during use, it is most likely that it a bug that exists in the standalone X Ubuntu configuration. Please attmempt to toggle back to the standalone X configuration & replicate the use case. If you succeed in only being able to repeat the visual corruption in XMir & not in standalone X, please file a bug with a detailed description of hardware used, XMir component versions used & the use case steps. You may check the versions of key XMir components by the following
83-
84- dpkg -s libmirclient0 | grep "Version"
85- dpkg -s libmirserver0 | grep "Version"
86- dpkg -s lightdm | grep "Version"
87- dpkg -s unity-system-compositor | grep "Version"
88+If you experience a UI lock up or a crash, it would be helpful to double check
89+for X backtracing which can be found here
90+
91+Note, it is highly unlikely you will see any visual corruption due to XMir. If
92+you experience a visual corruption during use, it is most likely that it a bug
93+that exists in the standalone X Ubuntu configuration. Please attmempt to toggle
94+back to the standalone X configuration and replicate the use case. If you
95+succeed in only being able to repeat the visual corruption in XMir and not in
96+standalone X, please file a bug with a detailed description of hardware used,
97+XMir component versions used and the use case steps. You may check the versions
98+of key XMir components by the following
99+
100+ dpkg -s libmirclient1 | grep Version
101+ dpkg -s libmirserver0 | grep Version
102+ dpkg -s lightdm | grep Version
103+ dpkg -s unity-system-compositor | grep Version
104

Subscribers

People subscribed via source and target branches

to all changes: