1
=== added file 'doc/debug_for_xmir.md'
2
--- doc/debug_for_xmir.md	1970-01-01 00:00:00 +0000
3
+++ doc/debug_for_xmir.md	2013-07-08 14:27:28 +0000
4
@@ -0,0 +1,85 @@
5
1
Debug for XMir {#debug_for_xmir}
6
2
=================
7
3
8
4
What is XMir ?
9
5
----------------
10
6
11
7
In order to help with debugging, it's important to understand what XMir is
12
8
and what bugs are likely to occur. XMir is not a replacement to X and does
13
9
not alter X or compiz window management functionality in the current Ubuntu
14
10
stack. XMir is an addition to the system. XMir enables Mir to be
15
11
employed as a system compositor under the X stack, in this configuration
16
12
Mir composites the greeter and the desktop sessions.
17
13
18
14
XMir is currently targeted at the Ubuntu 13.10 release as being the default
19
15
configuration. It currently supports open source graphics drivers based on
20
16
Mesa, Nouveau and Radeon. Once XMir is installed and properly configured,
21
17
upon boot or restart of the LightDM daemon, Mir will determine if there
22
18
is proper driver support; in the instance where proprietary drivers not
23
19
supporting the Mir driver model are detected, LightDM will continue to
24
20
boot into the standalone X configuration without error. From a visual
25
21
perspective on Ubuntu desktop, XMir and standalone X are identical (note,
26
22
currently there is an X cursor present on XMir but this soon be disabled,
27
23
making the experience truly identical and indiscernible without checking on
28
24
what processes are running, see \ref using_mir_on_pc).
29
25
30
26
How to toggle between XMir and standalone X ?
31
27
-------------------------------------
32
28
33
29
In order to return to a standalone X configuration, comment out the following
34
30
line in /etc/lightdm/lightdm.conf.d/10-unity-system-compositor.conf to look to
35
31
look like this:
36
32
37
33
    [SeatDefaults]
38
34
    #type=unity
39
35
40
36
Simply reboot or restart LightDM.
41
37
To reverse the process, simply comment the line back in to enable XMir.
42
38
43
39
Most common bugs
44
40
-------------------------------------
45
41
46
42
At the moment, the most common bugs are related to failures to boot into XMir.
47
43
Due to the robust fallback mechanisms in place, most failures will result in
48
44
completing the boot sequence standalone X configuration, when you expected
49
45
XMir.
50
46
51
47
1. First check your /etc/lightdm/lightdm.conf.d/10-unity-system-compositor.conf
52
48
   has type=unity properly enabled.
53
49
54
50
2. When logging a bug, please include the log files contained in the
55
51
   /var/log/lightdm/ directory. Note, it is good to inspect the last update to
56
52
   these files to see if they were written to in your boot attempt,
57
53
   obviously if they were not updated their contents are irrelevant.
58
54
   The most important of these files is likely the lightdm.log and
59
55
   unity-system-compositor.log. You are more than welcome to inspect these
60
56
   files, frequently there will be an error statement in
61
57
   unity-system-compositor.log which can be traced back into the source code
62
58
   for further debug.
63
59
64
60
3. If you have the experience of booting to a black screen which seems frozen,
65
61
   you may attempt to switch VT's by selecting <Ctrl+Alt+F8> to see if there is
66
62
   a UI present. Alternatively, <Ctrl+Alt+F1>, login at the console, copy out
67
63
   the log files mentioned above, then toggle back to standalone X as described
68
64
   above and rebooting.
69
65
70
66
Other bugs
71
67
-------------------------------------
72
68
73
69
If you experience a UI lock up or a crash, it would be helpful to double check
74
70
for X backtracing which can be found here: https://wiki.ubuntu.com/X/Debugging
75
71
76
72
Note, it is highly unlikely you will see any visual corruption due to XMir. If
77
73
you experience a visual corruption during use, it is most likely that it a bug
78
74
that exists in the standalone X Ubuntu configuration. Please attempt to toggle
79
75
back to the standalone X configuration and replicate the use case. If you
80
76
succeed in only being able to repeat the visual corruption in XMir and not in
81
77
standalone X, please file a bug with a detailed description of hardware used,
82
78
XMir component versions used and the use case steps. You may check the versions
83
79
of key XMir components by the following
84
80
85
81
    dpkg -s libmirclient1 | grep Version
86
82
    dpkg -s libmirserver0 | grep Version
87
83
    dpkg -s lightdm | grep Version
88
84
    dpkg -s unity-system-compositor | grep Version
89
85
90
0
86
91
=== modified file 'doc/mainpage.md'
92
--- doc/mainpage.md	2013-06-03 10:44:13 +0000
93
+++ doc/mainpage.md	2013-07-08 14:27:28 +0000
94
@@ -34,6 +34,7 @@
95
34
34
96
35
 - \ref using_mir_on_pc
35
 - \ref using_mir_on_pc
97
36
 - \ref using_mir_on_android
36
 - \ref using_mir_on_android
98
37
 - \ref debug_for_xmir
99
37
38
100
38
Getting involved
39
Getting involved
101
39
----------------
40
----------------
Status:	Merged
Approved by:	Daniel van Vugt on 2013-07-09
Approved revision:	no longer in the source branch.
Merged at revision:	828
Proposed branch:	lp:~kgunn72/mir/add_xmir_debug_guide
Merge into:	lp:~mir-team/mir/trunk
Diff against target:	101 lines (+86/-0) 2 files modified doc/debug_for_xmir.md (+85/-0) doc/mainpage.md (+1/-0)
To merge this branch:	bzr merge lp:~kgunn72/mir/add_xmir_debug_guide
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Daniel van Vugt			Abstain on 2013-07-09
Alan Griffiths			Approve on 2013-07-08
PS Jenkins bot (community)	continuous-integration		Approve on 2013-07-08
Robert Ancell		2013-07-05	Approve on 2013-07-07
Review via email: mp+173260@code.launchpad.net