Mir

Merge lp:~kgunn72/mir/add_xmir_debug_guide into lp:~mir-team/mir/trunk

Proposed by kevin gunn on 2013-07-05
Status: Merged
Approved by: Daniel van Vugt on 2013-07-09
Approved revision: 806
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
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

Commit message

add xmir guide to debug

Description of the change

there has been some requests for guidance on what sorts of bugs might exist for xmir & how to debug.
I'd like to propose this as a start.

To post a comment you must log in.
kevin gunn (kgunn72) wrote :

sorry...somehow it didn't load the new file

lp:~kgunn72/mir/add_xmir_debug_guide updated on 2013-07-05
803. By kevin gunn on 2013-07-05

really add the debug guide

Robert Ancell (robert-ancell) wrote :

"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" - Technically not correct, Unity System Compositor will quit and LightDM will start "traditional" X in this case.

lightdm -> LightDM
identicle -> identical
indescernable -> indiscernible
Xmir -> XMir
/var/log/light/ -> /var/log/lightdm/
attmempt -> attempt
libmirclient0 -> libmirclient1

"it would be helpful to double check for X backtracing which can be found here "

Missing the "here"?

Don't need the double quotes on the grep

>80 character width (I totally disagree with this requirement, but you'll never here the end of it from people using 1980s text terminals/editors).

ps. You love '&' don't you :)

Robert Ancell (robert-ancell) wrote :

I've corrected these and pushed the changes to lp:~robert-ancell/mir/add_xmir_debug_guide.

All fixed except for the missing "here".

Approved with those changes merged in.

review: Approve
Daniel van Vugt (vanvugt) wrote :

I'm confused. We should make sure fixes are in the branch before approving the branch.

So without reading the text I'm going to say: Please resolve Robert's merge request first:
https://code.launchpad.net/~robert-ancell/mir/add_xmir_debug_guide/+merge/173385

review: Needs Fixing
Alan Griffiths (alan-griffiths) wrote :

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

I find this sentence hard to parse. Does it mean:

"XMir is separate from Mir and enables Mir to be employed as a system compositor under the X stack, in this configuration Mir composites the greeter and the desktop sessions."

Like Daniel I think the merge should be addressed before approving.

review: Needs Fixing
lp:~kgunn72/mir/add_xmir_debug_guide updated on 2013-07-08
804. By kevin gunn on 2013-07-08

- merged robert's review changes
- add missing x link for debug
- updated intro sentence per Alan's comment

Gerry Boland (gerboland) wrote :

Some typos:

+In order to help with debug, its important
debug -> debugging
its -> it's

XMir enables enables Mir - enables twice

selecting <Ctrl+Alt+F8> - pressing?
Aleternatively -> "Alternatively, press"
and rebooting. -> and reboot.
attmempt -> attempt

lp:~kgunn72/mir/add_xmir_debug_guide updated on 2013-07-08
805. By kevin gunn on 2013-07-08

update grammar

Alan Griffiths (alan-griffiths) wrote :

11 +In order to help with debug, its important to understand what XMir is and what

its => it's

14 +is an addition to the system. XMir enables enables Mir to be employed as a

enables enables => enables

47 +Due to the robust fallback mechanisms in place, you will realize this

realize => experience

53 +2. If you desire to log a bug, please include the log files contained in the

If you desire to log a bug => When logging a bug

77 +that exists in the standalone X Ubuntu configuration. Please attmempt to toggle

attmempt => attempt

review: Needs Fixing
lp:~kgunn72/mir/add_xmir_debug_guide updated on 2013-07-08
806. By kevin gunn on 2013-07-08

some more reword & typos

Alan Griffiths (alan-griffiths) wrote :

27 +making the experience truly identical and indiscernible without checking on

it is the difference that is "indiscernible", not the experience. But not a blocker.

review: Approve
Daniel van Vugt (vanvugt) wrote :

OK, my concern is resolved. And we already have enough approvers.

review: Abstain

Preview Diff

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

Subscribers

People subscribed via source and target branches