Mir

Merge lp:~raof/mir/document-reality into lp:~mir-team/mir/trunk

Proposed by Chris Halse Rogers
Status: Merged
Approved by: Robert Ancell
Approved revision: no longer in the source branch.
Merged at revision: 652
Proposed branch: lp:~raof/mir/document-reality
Merge into: lp:~mir-team/mir/trunk
Diff against target: 107 lines (+28/-44)
2 files modified
HACKING.md (+19/-29)
doc/using_mir_on_pc.md (+9/-15)
To merge this branch: bzr merge lp:~raof/mir/document-reality
Reviewer Review Type Date Requested Status
PS Jenkins bot (community) continuous-integration Approve
Kevin DuBois (community) Approve
Alexandros Frantzis (community) Approve
Daniel van Vugt Needs Fixing
Review via email: mp+161895@code.launchpad.net

Commit message

Update Running On PC documentation

Description of the change

Make documentation match reality

To post a comment you must log in.
Revision history for this message
Daniel van Vugt (vanvugt) wrote :

The same clarification needs to be made in HACKING.md

review: Needs Fixing
Revision history for this message
Alexandros Frantzis (afrantzis) wrote :

Probably not in scope for this MP, but I suggest that in HACKING.md we don't duplicate any information, and provide pointers to the relevant doc/ files instead.

review: Approve
Revision history for this message
Kevin DuBois (kdub) wrote :

well, i'll approve, but it is probably better to move the Hacking.md's "Running Mir" section to using_mir_on_pc.md

review: Approve
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Approve (continuous-integration)
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Needs Fixing (continuous-integration)
Revision history for this message
PS Jenkins bot (ps-jenkins) :
review: Approve (continuous-integration)
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Needs Fixing (continuous-integration)
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Approve (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'HACKING.md'
--- HACKING.md 2013-04-26 10:39:19 +0000
+++ HACKING.md 2013-05-01 19:14:27 +0000
@@ -99,7 +99,7 @@
99from dying at the same time.99from dying at the same time.
100100
1011. Make sure your hardware is supported. That means you're using a Mesa driver,1011. Make sure your hardware is supported. That means you're using a Mesa driver,
102 of which only intel and radeon families are presently supported. If you're102 of which intel, radeon, and nouveau families are supported. If you're
103 logged in to X then run this command to verify an appropriate DRI driver103 logged in to X then run this command to verify an appropriate DRI driver
104 is active:104 is active:
105 sudo pmap `pidof X` | grep dri.so105 sudo pmap `pidof X` | grep dri.so
@@ -115,34 +115,24 @@
115115
1163. Build Mir as described at the top of this document.1163. Build Mir as described at the top of this document.
117117
1184. Log in to VT1 (Ctrl+Alt+F1) _after_ you are already logged in to X. If you1184. Log in to VT1 (Ctrl+Alt+F1)
119 do so before then you will not be assigned adequate credentials to access119
120 the graphics hardware and will get strange errors.1205. Start Mir as root:
121121
1225. Note that you can switch back to X using Alt+F7. But it is very important122 $ cd <mir_source_dir>/build/bin
123 to remember NOT to switch once you have any mir binaries running. Doing123 $ sudo ./mir
124 so will make X die (!).124
1251256. To VT2: Ctrl+Alt+F2
1266. Switch back to VT1: Ctrl+Alt+F1126
1271277. Fix permissions on the Mir socket so that non-root clients can connect:
1287. Now we want to run the mir server and a client to render something. The128
129 trick is that we need to make sure the mir server is easy to terminate129 $ sudo chmod 777 /tmp/mir_socket
130 before ever switching back to X. To ensure this, the server needs to be in130
131 the foreground, but starting before your client (in the background). To1318. Start a mir client
132 do this, you must:132
133 cd <mir_source_dir>/build/bin133 $ ./mir_demo_client_accelerated
134 (sleep 5; ./mir_demo_client_accelerated) & ./mir ; kill $!134
1351359. Switch back to Mir on VT1 (Ctrl+Alt+F1)
136 Wait 5 seconds and the client will start. You can kill it with Ctrl+C or
137 Alt+F2,Alt+F1,Ctrl+C. REMEMBER to kill the mir processes fully before
138 attempting to switch back to X or your X login will die.
139
1408. In case you accidentally killed your X login and ended up with a failsafe
141 screen, you might find on subsequent reboots you can't log in to X at all
142 any more (it instantly and silently takes you back to the login screen).
143 The fix for this is to log in to a VT and:
144 rm .Xauthority
145 sudo restart lightdm
146136
147137
148Documentation138Documentation
149139
=== modified file 'doc/using_mir_on_pc.md'
--- doc/using_mir_on_pc.md 2013-03-11 14:23:19 +0000
+++ doc/using_mir_on_pc.md 2013-05-01 19:14:27 +0000
@@ -27,7 +27,7 @@
27 [SeatDefaults]27 [SeatDefaults]
28 user-session=ubuntu28 user-session=ubuntu
29 greeter-session=unity-greeter29 greeter-session=unity-greeter
30 type=mir30 type=unity
3131
32Now restart lightdm:32Now restart lightdm:
3333
@@ -48,20 +48,14 @@
48assigned adequate credentials to access the graphics hardware and will get48assigned adequate credentials to access the graphics hardware and will get
49strange errors.49strange errors.
5050
51Note that you can switch back to X using Alt+F7. But it is very important to51VT switching away from Mir will only work if Mir is run as root. In this case
52remember NOT to switch once you have any mir binaries running. Doing so will52we need to change the permissions to the Mir socket so that clients can connect:
53currently make X die (!).53
5454 $ sudo mir
55Now we want to run the mir server and a client to render something. The trick55 <Ctrl+Alt+F2> - log in to VT 2
56is that we need to make sure the mir server is easy to terminate before ever56 $ sudo chmod 777 /tmp/mir_socket
57switching back to X. To ensure this, the server needs to be in the foreground,57 $ some-mir-client
58but starting before your client (in the background). To do this, you must:58 <Ctrl+Alt+F1> - switch back to mir. Watch your friends be amazed!
59
60 $ (sleep 3; some-mir-client) & mir ; kill $!
61
62Wait 3 seconds and the client will start. You can kill it with Ctrl+C. REMEMBER
63to kill the mir processes fully before attempting to switch back to X or your X
64login will die.
6559
66In case you accidentally killed your X login and ended up with a failsafe60In case you accidentally killed your X login and ended up with a failsafe
67screen, you might find on subsequent reboots you can't log in to X at all any61screen, you might find on subsequent reboots you can't log in to X at all any

Subscribers

People subscribed via source and target branches