Merge lp:~vanvugt/mir/undocument-xmir into lp:mir

[Daniel van Vugt]

Remove documentation about the old xmir. It's long dead (LP: #1200114)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:2984
http://jenkins.qa.ubuntu.com/job/mir-ci/5113/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/4242
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/3149
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/4184
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-wily-touch/142/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/1267
        deb: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/1267/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-wily-i386-ci/142/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4185
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4185/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/6858
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/23891
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-wily-armhf/143/console

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

review: Approve (continuous-integration)

[Alan Griffiths (alan-griffiths)]

Yep.

There's other stuff that's out of date too. But beyond current scope.

review: Approve

=== modified file 'doc/building_source_for_pc.md'
--- doc/building_source_for_pc.md	2013-08-28 03:41:48 +0000
+++ doc/building_source_for_pc.md	2015-10-02 10:04:24 +0000
@@ -65,50 +65,3 @@
 
 Compile as per normal instructions and pass --with-egl-platforms="mir,drm" to
 the configure options. You will need libmirclient installed as shown above.
-
-Building X.Org
---------------
-
-To run an X server inside Mir you need to build a patched version of the X.Org
-X server.
-
-The patch is hosted on GitHub:
-
-    $ git clone https://github.com/RAOF/xserver.git
-
-Compile as per normal instructions and pass --enable-xmir to the configure
-options. You will need libmirclient installed as shown above.
-
-Building the X.Org drivers
---------------------------
-
-To run an X server inside Mir you also need a patched version of your X.Org
-video driver.
-
-The three drivers - Intel, Radeon, and Nouveau -  are available on Launchpad:
-
-    $ bzr branch lp:~mir-team/mir/xf86-video-intel-vladmir
-    $ bzr branch lp:~mir-team/mir/xf86-video-ati-vladmir
-    $ bzr branch lp:~mir-team/mir/xf86-video-nouveau
-
-Compile as per normal instructions. These need to be built after the X server,
-as they depend on new interfaces there.
-
-Building Unity System Compositor
---------------------------------
-
-If you want to run a full system using XMir then you need to use a system
-compositor. For Ubuntu we have a system compositor project on Launchpad
-(https://launchpad.net/unity-system-compositor). Compile with the following:
-
-    $ bzr branch lp:unity-system-compositor
-    $ cd unity-system-compositor
-    $ mkdir build
-    $ cd build
-    $ cmake ..
-
-You will need libmirserver installed as shown above.
-
-To use the system compositor you need a display manager that supports it. At the
-time of writing LightDM is the only display manager with support and has been
-available since version 1.7.4.

=== removed file 'doc/debug_for_xmir.md'
--- doc/debug_for_xmir.md	2013-09-12 21:36:55 +0000
+++ doc/debug_for_xmir.md	1970-01-01 00:00:00 +0000
@@ -1,85 +0,0 @@
-Debug for XMir {#debug_for_xmir}
-=================
-
-What is XMir ?
-----------------
-
-In order to help with debugging, it's important to understand what XMir is
-and 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. XMir enables Mir to be
-employed as a system compositor under the X stack, in this configuration
-Mir composites the greeter and the desktop sessions.
-
-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 and Radeon. Once XMir is installed and properly configured,
-upon boot or restart of the LightDM daemon, Mir will determine if there
-is proper driver support; in the instance where proprietary drivers not
-supporting the Mir driver model are detected, LightDM will continue to
-boot into the standalone X configuration without error. From a visual
-perspective on Ubuntu desktop, XMir and standalone X are identical (note,
-currently there is an X cursor present on XMir but this soon be disabled,
-making the experience truly identical and indiscernible without checking on
-what processes are running, see \ref using_mir_on_pc).
-
-How to toggle between XMir and standalone X ?
--------------------------------------
-
-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:
-
-    [SeatDefaults]
-    #type=unity
-
-Simply reboot or restart LightDM.
-To reverse the process, simply comment the line back in to enable XMir.
-
-Most common bugs
--------------------------------------
-
-At the moment, the most common bugs are related to failures to boot into XMir.
-Due to the robust fallback mechanisms in place, most failures will result in
-completing the boot sequence standalone X configuration, when you expected
-XMir.
-
-1. First check your /etc/lightdm/lightdm.conf.d/10-unity-system-compositor.conf
-   has type=unity properly enabled.
-
-2. When logging a bug, please include the log files contained in the
-   /var/log/lightdm/ 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 and
-   unity-system-compositor.log. You are more than welcome to inspect these
-   files, frequently there will be an error statement in
-   unity-system-compositor.log which can be traced back into the source code
-   for further debug.
-
-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. Alternatively, <Ctrl+Alt+F1>, login at the console, copy out
-   the log files mentioned above, then toggle back to standalone X as described
-   above and rebooting.
-
-Other bugs
--------------------------------------
-
-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: https://wiki.ubuntu.com/X/Debugging
-
-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 attempt to toggle
-back to the standalone X configuration and replicate the use case. If you
-succeed in only being able to repeat the visual corruption in XMir and not in
-standalone X, please file a bug with a detailed description of hardware used,
-XMir component versions used and the use case steps. You may check the versions
-of key XMir components by the following
-
-    dpkg -s libmirclient3 | grep Version
-    dpkg -s libmirserver0 | grep Version
-    dpkg -s lightdm | grep Version
-    dpkg -s unity-system-compositor | grep Version
-

=== modified file 'doc/installing_prebuilt_on_pc.md'
--- doc/installing_prebuilt_on_pc.md	2014-03-06 06:05:17 +0000
+++ doc/installing_prebuilt_on_pc.md	2015-10-02 10:04:24 +0000
@@ -4,12 +4,5 @@
 Install Ubuntu 13.10 or later if you haven't done so already.  Uninstall any
 proprietary drivers (-nvidia, -fglrx) and reboot on the FOSS drivers.
 
-Install Mir in Ubuntu 13.10:
-
-       sudo apt-get update
-       sudo apt-get install mir-demos unity-system-compositor
-
-Install Mir in Ubuntu 14.04 or later:
-
-       sudo apt-get update
-       sudo apt-get install mir-demos ubuntu-desktop-mir
+       sudo apt-get update
+       sudo apt-get install mir-demos

=== modified file 'doc/mainpage.md'
--- doc/mainpage.md	2015-06-26 11:31:44 +0000
+++ doc/mainpage.md	2015-10-02 10:04:24 +0000
@@ -41,7 +41,6 @@
 
  - \ref using_mir_on_pc
  - \ref using_mir_on_android
- - \ref debug_for_xmir
  - \ref demo_shell_controls
  - \ref demo_server
 

=== modified file 'doc/using_mir_on_pc.md'
--- doc/using_mir_on_pc.md	2015-02-22 07:46:25 +0000
+++ doc/using_mir_on_pc.md	2015-10-02 10:04:24 +0000
@@ -24,68 +24,10 @@
 custom Mesa yourself and ensuring it can be found by Mir, e.g., by using
 LD_LIBRARY_PATH.
 
-Using Mir as system compositor with X
--------------------------------------
-
-Note: for this to work you need to have Mir and all its dependencies (which
-include lightdm, Mesa and the Xorg drivers). The easiest way is to run Ubuntu
-13.10 or later.
-
-If you are running Ubuntu 13.10, additionally install unity-system-compositor.
-If you are running Ubuntu 14.04 or later, instead install ubuntu-desktop-mir.
-These packages will install dependencies you need and will create a file in
-/etc/lightdm/lightdm.conf.d/10-unity-system-compositor.conf.
-
-If you have instead built from source, to set up the system compositor, create
-/etc/lightdm/lightdm.conf.d/10-unity-system-compositor.conf yourself and make
-it look like this:
-
-    [SeatDefaults]
-    type=unity
-
-Now restart lightdm:
-
-    $ sudo restart lightdm
-
-Or you may simply reboot.
-
-In theory, you should now find yourself back in Ubuntu and not notice
-anything different. You can verify you're in Mir several ways:
-
-    $ ps aux | grep unity-system-compositor
-    $ grep -i xmir /var/log/Xorg.0.log
-    $ ls -l /var/log/lightdm/unity-system-compositor.log
-
-If problems occur, have a look at the following log files:
-
-    /var/log/lightdm/lightdm.log
-    /var/log/lightdm/unity-system-compositor.log
-    /var/log/lightdm/x-0.log
-    /var/log/Xorg.0.log
-
-You may not be able to get to a terminal if your video system has locked up. In
-that case secure shell into to your machine and read / copy these logs. They are
-overwritten on next boot.
-
-In any case, if you wish to deactivate XMir upon boot, simply comment out
-the type=unity line from
-/etc/lightdm/lightdm.conf.d/10-unity-system-compositor.conf, like this:
-
-    [SeatDefaults]
-    #type=unity
-
-If you cannot boot into a graphical display or terminal to disable XMir, then
-enter recovery mode as described in https://wiki.ubuntu.com/RecoveryMode. From
-there edit / move / remove
-/etc/lightdm/lightdm.conf.d/10-unity-system-compositor.conf and then reboot.
-To modify the filesystem you will need to enter the following command:
-
-    # mount / -o remount,rw
-
 Running Mir natively
 --------------------
 
-You can also run Mir natively. To do so, log in to VT1 (Ctrl+Alt+F1) _after_
+To run Mir natively on a PC/desktop/laptop, log in to VT1 (Ctrl+Alt+F1) _after_
 you are already logged in to X.  If you do so before then you will not be
 assigned adequate credentials to access the graphics hardware and will get
 strange errors.