Mir

Merge lp:~alan-griffiths/mir/update-docs into lp:mir

Proposed by Alan Griffiths on 2017-09-27
Status: Merged
Merged at revision: 4276
Proposed branch: lp:~alan-griffiths/mir/update-docs
Merge into: lp:mir
Diff against target: 76 lines (+29/-7)
2 files modified
doc/Doxyfile.in (+9/-5)
doc/mainpage.md (+20/-2)
To merge this branch: bzr merge lp:~alan-griffiths/mir/update-docs
Reviewer Review Type Date Requested Status
Mir CI Bot continuous-integration Needs Fixing on 2017-09-29
Brandon Schaefer (community) 2017-09-27 Approve on 2017-09-29
Review via email: mp+331448@code.launchpad.net

Commit message

Rework to mention snaps and Wayland

To post a comment you must log in.
Mir CI Bot (mir-ci-bot) wrote :

PASSED: Continuous integration, rev:4274
https://mir-jenkins.ubuntu.com/job/mir-ci/3701/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/5074
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/5310
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=artful/5298
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/5298
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/5298
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=artful/5118
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=artful/5118/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/5118
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/5118/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=artful/5118
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=artful/5118/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/5118
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/5118/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/5118
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/5118/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=artful/5118
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=artful/5118/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=zesty/5118
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=zesty/5118/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/5118
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/5118/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/3701/rebuild

review: Approve (continuous-integration)
Mir CI Bot (mir-ci-bot) wrote :

FAILED: Continuous integration, rev:4275
https://mir-jenkins.ubuntu.com/job/mir-ci/3702/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/5076/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/5314
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=artful/5302
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/5302
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/5302
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=artful/5120
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=artful/5120/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/5120
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/5120/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=artful/5120
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=artful/5120/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/5120
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/5120/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/5120
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/5120/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=artful/5120
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=artful/5120/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=zesty/5120
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=zesty/5120/artifact/output/*zip*/output.zip
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/5120/console

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/3702/rebuild

review: Needs Fixing (continuous-integration)
Mir CI Bot (mir-ci-bot) wrote :

PASSED: Continuous integration, rev:4279
https://mir-jenkins.ubuntu.com/job/mir-ci/3703/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/5077
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/5315
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=artful/5303
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/5303
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/5303
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=artful/5121
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=artful/5121/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/5121
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/5121/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=artful/5121
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=artful/5121/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/5121
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/5121/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/5121
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/5121/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=artful/5121
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=artful/5121/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=zesty/5121
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=zesty/5121/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/5121
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/5121/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/3703/rebuild

review: Approve (continuous-integration)
Brandon Schaefer (brandontschaefer) wrote :

lgtm

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'doc/Doxyfile.in'
2--- doc/Doxyfile.in 2017-09-07 09:53:20 +0000
3+++ doc/Doxyfile.in 2017-09-28 13:33:53 +0000
4@@ -784,7 +784,8 @@
5 INPUT = @CMAKE_CURRENT_SOURCE_DIR@/README.md \
6 @CMAKE_CURRENT_SOURCE_DIR@/HACKING.md \
7 @CMAKE_CURRENT_SOURCE_DIR@/doc \
8- @CMAKE_CURRENT_SOURCE_DIR@/examples \
9+ @CMAKE_CURRENT_SOURCE_DIR@/examples/miral-kiosk \
10+ @CMAKE_CURRENT_SOURCE_DIR@/examples/miral-shell \
11 @CMAKE_CURRENT_SOURCE_DIR@/include \
12 @MIR_GENERATED_INCLUDE_DIRECTORIES_FLATTENED@
13
14@@ -859,7 +860,9 @@
15 # Note that relative paths are relative to the directory from which doxygen is
16 # run.
17
18-EXCLUDE =
19+EXCLUDE = @CMAKE_CURRENT_SOURCE_DIR@/include/server \
20+ @CMAKE_CURRENT_SOURCE_DIR@/include/platform \
21+ @CMAKE_CURRENT_SOURCE_DIR@/include/platforms
22
23 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
24 # directories that are symbolic links (a Unix file system feature) are excluded
25@@ -876,9 +879,10 @@
26 # exclude all test directories for example use the pattern */test/*
27
28 EXCLUDE_PATTERNS = *.capnp.c++ \
29- @CMAKE_CURRENT_SOURCE_DIR@/include/server/* \
30- @CMAKE_CURRENT_SOURCE_DIR@/include/test/mir/* \
31- @CMAKE_CURRENT_SOURCE_DIR@/examples/multi_stream.cpp
32+ */detail/* \
33+ @CMAKE_CURRENT_SOURCE_DIR@/examples/multi_stream.cpp \
34+ @CMAKE_CURRENT_SOURCE_DIR@/examples/uses_non_client_symbol.cpp \
35+ @CMAKE_CURRENT_SOURCE_DIR@/examples/miral-shell/titlebar_config.*
36
37 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
38 # (namespaces, classes, functions, etc.) that should be excluded from the
39
40=== modified file 'doc/mainpage.md'
41--- doc/mainpage.md 2017-09-08 13:26:03 +0000
42+++ doc/mainpage.md 2017-09-28 13:33:53 +0000
43@@ -5,14 +5,32 @@
44 window server system to unlock next-generation user experiences for devices
45 ranging from Linux desktop to mobile and IoT devices powered by Ubuntu.
46
47- - If you just want to try out the Mir demos, see: \ref getting_and_using_mir
48+ - If you want to use the Mir snaps, see:
49+ [Run a kiosk snap on Ubuntu Core](https://developer.ubuntu.com/core/examples/snaps-on-mir)
50+
51+ - If you want to try out the Mir demos on desktop, see: \ref getting_and_using_mir
52
53 - If you want to get involved in Mir development, see: \ref getting_involved_in_mir
54
55 Using Mir for client development
56 --------------------------------
57
58-Install the headers and libraries for using libmirclient in development:
59+This is usually something you don't need to do explicitly, it is normally
60+handled by a GUI toolkit (or library).
61+
62+A toolkit can run on Mir in three ways: using Wayland protocols, using the Mir
63+client API or using X11 translation by the Xmir server.
64+
65+ - Qt, has "wayland" and "mir" plugins that can be selected by setting
66+ the QT_QPA_PLATFORM environment variable to "wayland" or "ubuntumirclient"
67+ respectively.
68+
69+ - SDL can be built with "wayland" and "mir" support and these options selected
70+ by setting the SDL_VIDEODRIVER environment variable to "wayland" or "mir".
71+
72+If want to use the Mir client library directly (e.g. you are working on "mir"
73+support for a toolkit or library) Install the headers and libraries for using
74+libmirclient in development:
75
76 $ sudo apt install libmirclient-dev
77

Subscribers

People subscribed via source and target branches