Mir

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

  1. document-reality
  2. Merge into 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 :

PASSED: Continuous integration, rev:642
http://jenkins.qa.ubuntu.com/job/mir-ci/528/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-raring-i386-build/590
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-raring-amd64-build/473
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-raring-amd64-ci/12
        deb: http://jenkins.qa.ubuntu.com/job/mir-raring-amd64-ci/12/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-vm-ci-build/./distribution=precise,flavor=amd64/264/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/mir-ci/528/rebuild

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

FAILED: Continuous integration, rev:643
http://jenkins.qa.ubuntu.com/job/mir-ci/532/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-android-raring-i386-build/595/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-raring-amd64-build/478
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-raring-amd64-ci/16
        deb: http://jenkins.qa.ubuntu.com/job/mir-raring-amd64-ci/16/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-vm-ci-build/./distribution=precise,flavor=amd64/268/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/mir-ci/532/rebuild

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 :

FAILED: Autolanding.
Unapproved changes made after approval.
http://jenkins.qa.ubuntu.com/job/mir-autolanding/217/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-raring-i386-build/601
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-raring-amd64-build/484
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-raring-amd64-autolanding/7
        deb: http://jenkins.qa.ubuntu.com/job/mir-raring-amd64-autolanding/7/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-vm-autolanding-build/./distribution=quantal,flavor=amd64/106

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

PASSED: Continuous integration, rev:644
http://jenkins.qa.ubuntu.com/job/mir-ci/537/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-raring-i386-build/602
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-raring-amd64-build/485
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-raring-amd64-ci/21
        deb: http://jenkins.qa.ubuntu.com/job/mir-raring-amd64-ci/21/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-vm-ci-build/./distribution=precise,flavor=amd64/275

Click here to trigger a rebuild:
http://s-jenkins:8080/job/mir-ci/537/rebuild

review: Approve (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'HACKING.md'
2--- HACKING.md 2013-04-26 10:39:19 +0000
3+++ HACKING.md 2013-05-01 19:14:27 +0000
4@@ -99,7 +99,7 @@
5 from dying at the same time.
6
7 1. Make sure your hardware is supported. That means you're using a Mesa driver,
8- of which only intel and radeon families are presently supported. If you're
9+ of which intel, radeon, and nouveau families are supported. If you're
10 logged in to X then run this command to verify an appropriate DRI driver
11 is active:
12 sudo pmap `pidof X` | grep dri.so
13@@ -115,34 +115,24 @@
14
15 3. Build Mir as described at the top of this document.
16
17-4. Log in to VT1 (Ctrl+Alt+F1) _after_ you are already logged in to X. If you
18- do so before then you will not be assigned adequate credentials to access
19- the graphics hardware and will get strange errors.
20-
21-5. Note that you can switch back to X using Alt+F7. But it is very important
22- to remember NOT to switch once you have any mir binaries running. Doing
23- so will make X die (!).
24-
25-6. Switch back to VT1: Ctrl+Alt+F1
26-
27-7. Now we want to run the mir server and a client to render something. The
28- trick is that we need to make sure the mir server is easy to terminate
29- before ever switching back to X. To ensure this, the server needs to be in
30- the foreground, but starting before your client (in the background). To
31- do this, you must:
32- cd <mir_source_dir>/build/bin
33- (sleep 5; ./mir_demo_client_accelerated) & ./mir ; kill $!
34-
35- Wait 5 seconds and the client will start. You can kill it with Ctrl+C or
36- Alt+F2,Alt+F1,Ctrl+C. REMEMBER to kill the mir processes fully before
37- attempting to switch back to X or your X login will die.
38-
39-8. In case you accidentally killed your X login and ended up with a failsafe
40- screen, you might find on subsequent reboots you can't log in to X at all
41- any more (it instantly and silently takes you back to the login screen).
42- The fix for this is to log in to a VT and:
43- rm .Xauthority
44- sudo restart lightdm
45+4. Log in to VT1 (Ctrl+Alt+F1)
46+
47+5. Start Mir as root:
48+
49+ $ cd <mir_source_dir>/build/bin
50+ $ sudo ./mir
51+
52+6. To VT2: Ctrl+Alt+F2
53+
54+7. Fix permissions on the Mir socket so that non-root clients can connect:
55+
56+ $ sudo chmod 777 /tmp/mir_socket
57+
58+8. Start a mir client
59+
60+ $ ./mir_demo_client_accelerated
61+
62+9. Switch back to Mir on VT1 (Ctrl+Alt+F1)
63
64
65 Documentation
66
67=== modified file 'doc/using_mir_on_pc.md'
68--- doc/using_mir_on_pc.md 2013-03-11 14:23:19 +0000
69+++ doc/using_mir_on_pc.md 2013-05-01 19:14:27 +0000
70@@ -27,7 +27,7 @@
71 [SeatDefaults]
72 user-session=ubuntu
73 greeter-session=unity-greeter
74- type=mir
75+ type=unity
76
77 Now restart lightdm:
78
79@@ -48,20 +48,14 @@
80 assigned adequate credentials to access the graphics hardware and will get
81 strange errors.
82
83-Note that you can switch back to X using Alt+F7. But it is very important to
84-remember NOT to switch once you have any mir binaries running. Doing so will
85-currently make X die (!).
86-
87-Now we want to run the mir server and a client to render something. The trick
88-is that we need to make sure the mir server is easy to terminate before ever
89-switching back to X. To ensure this, the server needs to be in the foreground,
90-but starting before your client (in the background). To do this, you must:
91-
92- $ (sleep 3; some-mir-client) & mir ; kill $!
93-
94-Wait 3 seconds and the client will start. You can kill it with Ctrl+C. REMEMBER
95-to kill the mir processes fully before attempting to switch back to X or your X
96-login will die.
97+VT switching away from Mir will only work if Mir is run as root. In this case
98+we need to change the permissions to the Mir socket so that clients can connect:
99+
100+ $ sudo mir
101+ <Ctrl+Alt+F2> - log in to VT 2
102+ $ sudo chmod 777 /tmp/mir_socket
103+ $ some-mir-client
104+ <Ctrl+Alt+F1> - switch back to mir. Watch your friends be amazed!
105
106 In case you accidentally killed your X login and ended up with a failsafe
107 screen, you might find on subsequent reboots you can't log in to X at all any

Subscribers

People subscribed via source and target branches