summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/technical-details.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-01-11 11:51:23 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-02-14 15:25:28 +0000
commit16e417be63e7cc79d88ec3fcf680b46e624ea9f7 (patch)
treeec4b1070d58709d626a449bff1ff4ab86505016a /documentation/ref-manual/technical-details.xml
parent99980546fa5482447bebb6ab0a1bd5c7a4148157 (diff)
downloadpoky-16e417be63e7cc79d88ec3fcf680b46e624ea9f7.tar.gz
overview-manual, ref-manual: Moved "Wayland" section to overview manual
Fixes [YOCTO #12370] The "Wayland" section needed to be moved to the concpets chapter in the new overview-manual. I moved it and fixed a few links that needed adjusting due to the move. (From yocto-docs rev: b8e84a8cb47194b0d20fe155561d9a346916068b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/technical-details.xml')
-rw-r--r--documentation/ref-manual/technical-details.xml132
1 files changed, 0 insertions, 132 deletions
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml
index 2b4f2d933c..ba0b27ddc9 100644
--- a/documentation/ref-manual/technical-details.xml
+++ b/documentation/ref-manual/technical-details.xml
@@ -13,138 +13,6 @@
13 x32, Wayland support, and Licenses. 13 x32, Wayland support, and Licenses.
14 </para> 14 </para>
15 15
16<section id="wayland">
17 <title>Wayland</title>
18
19 <para>
20 <ulink url='http://en.wikipedia.org/wiki/Wayland_(display_server_protocol)'>Wayland</ulink>
21 is a computer display server protocol that
22 provides a method for compositing window managers to communicate
23 directly with applications and video hardware and expects them to
24 communicate with input hardware using other libraries.
25 Using Wayland with supporting targets can result in better control
26 over graphics frame rendering than an application might otherwise
27 achieve.
28 </para>
29
30 <para>
31 The Yocto Project provides the Wayland protocol libraries and the
32 reference
33 <ulink url='http://en.wikipedia.org/wiki/Wayland_(display_server_protocol)#Weston'>Weston</ulink>
34 compositor as part of its release.
35 This section describes what you need to do to implement Wayland and
36 use the compositor when building an image for a supporting target.
37 </para>
38
39 <section id="wayland-support">
40 <title>Support</title>
41
42 <para>
43 The Wayland protocol libraries and the reference Weston compositor
44 ship as integrated packages in the <filename>meta</filename> layer
45 of the
46 <link linkend='source-directory'>Source Directory</link>.
47 Specifically, you can find the recipes that build both Wayland
48 and Weston at <filename>meta/recipes-graphics/wayland</filename>.
49 </para>
50
51 <para>
52 You can build both the Wayland and Weston packages for use only
53 with targets that accept the
54 <ulink url='http://dri.freedesktop.org/wiki/'>Mesa 3D and Direct Rendering Infrastructure</ulink>,
55 which is also known as Mesa DRI.
56 This implies that you cannot build and use the packages if your
57 target uses, for example, the
58 <trademark class='registered'>Intel</trademark> Embedded Media and
59 Graphics Driver (<trademark class='registered'>Intel</trademark>
60 EMGD) that overrides Mesa DRI.
61 </para>
62
63 <note>
64 Due to lack of EGL support, Weston 1.0.3 will not run directly on
65 the emulated QEMU hardware.
66 However, this version of Weston will run under X emulation without
67 issues.
68 </note>
69 </section>
70
71 <section id="enabling-wayland-in-an-image">
72 <title>Enabling Wayland in an Image</title>
73
74 <para>
75 To enable Wayland, you need to enable it to be built and enable
76 it to be included in the image.
77 </para>
78
79 <section id="enable-building">
80 <title>Building</title>
81
82 <para>
83 To cause Mesa to build the <filename>wayland-egl</filename>
84 platform and Weston to build Wayland with Kernel Mode
85 Setting
86 (<ulink url='https://wiki.archlinux.org/index.php/Kernel_Mode_Setting'>KMS</ulink>)
87 support, include the "wayland" flag in the
88 <link linkend="var-DISTRO_FEATURES"><filename>DISTRO_FEATURES</filename></link>
89 statement in your <filename>local.conf</filename> file:
90 <literallayout class='monospaced'>
91 DISTRO_FEATURES_append = " wayland"
92 </literallayout>
93 </para>
94
95 <note>
96 If X11 has been enabled elsewhere, Weston will build Wayland
97 with X11 support
98 </note>
99 </section>
100
101 <section id="enable-installation-in-an-image">
102 <title>Installing</title>
103
104 <para>
105 To install the Wayland feature into an image, you must
106 include the following
107 <link linkend='var-CORE_IMAGE_EXTRA_INSTALL'><filename>CORE_IMAGE_EXTRA_INSTALL</filename></link>
108 statement in your <filename>local.conf</filename> file:
109 <literallayout class='monospaced'>
110 CORE_IMAGE_EXTRA_INSTALL += "wayland weston"
111 </literallayout>
112 </para>
113 </section>
114 </section>
115
116 <section id="running-weston">
117 <title>Running Weston</title>
118
119 <para>
120 To run Weston inside X11, enabling it as described earlier and
121 building a Sato image is sufficient.
122 If you are running your image under Sato, a Weston Launcher appears
123 in the "Utility" category.
124 </para>
125
126 <para>
127 Alternatively, you can run Weston through the command-line
128 interpretor (CLI), which is better suited for development work.
129 To run Weston under the CLI, you need to do the following after
130 your image is built:
131 <orderedlist>
132 <listitem><para>Run these commands to export
133 <filename>XDG_RUNTIME_DIR</filename>:
134 <literallayout class='monospaced'>
135 mkdir -p /tmp/$USER-weston
136 chmod 0700 /tmp/$USER-weston
137 export XDG_RUNTIME_DIR=/tmp/$USER-weston
138 </literallayout></para></listitem>
139 <listitem><para>Launch Weston in the shell:
140 <literallayout class='monospaced'>
141 weston
142 </literallayout></para></listitem>
143 </orderedlist>
144 </para>
145 </section>
146</section>
147
148<section id="licenses"> 16<section id="licenses">
149 <title>Licenses</title> 17 <title>Licenses</title>
150 18