summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--documentation/overview-manual/overview-concepts.xml135
-rw-r--r--documentation/ref-manual/ref-images.xml3
-rw-r--r--documentation/ref-manual/technical-details.xml132
3 files changed, 137 insertions, 133 deletions
diff --git a/documentation/overview-manual/overview-concepts.xml b/documentation/overview-manual/overview-concepts.xml
index 74ce7fd52f..a7d6d2f6fb 100644
--- a/documentation/overview-manual/overview-concepts.xml
+++ b/documentation/overview-manual/overview-concepts.xml
@@ -1325,6 +1325,141 @@
1325 </para> 1325 </para>
1326 </section> 1326 </section>
1327 1327
1328 <section id="wayland">
1329 <title>Wayland</title>
1330
1331 <para>
1332 <ulink url='http://en.wikipedia.org/wiki/Wayland_(display_server_protocol)'>Wayland</ulink>
1333 is a computer display server protocol that
1334 provides a method for compositing window managers to communicate
1335 directly with applications and video hardware and expects them to
1336 communicate with input hardware using other libraries.
1337 Using Wayland with supporting targets can result in better control
1338 over graphics frame rendering than an application might otherwise
1339 achieve.
1340 </para>
1341
1342 <para>
1343 The Yocto Project provides the Wayland protocol libraries and the
1344 reference
1345 <ulink url='http://en.wikipedia.org/wiki/Wayland_(display_server_protocol)#Weston'>Weston</ulink>
1346 compositor as part of its release.
1347 This section describes what you need to do to implement Wayland and
1348 use the compositor when building an image for a supporting target.
1349 </para>
1350
1351 <section id="wayland-support">
1352 <title>Support</title>
1353
1354 <para>
1355 The Wayland protocol libraries and the reference Weston
1356 compositor ship as integrated packages in the
1357 <filename>meta</filename> layer of the
1358 <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.
1359 Specifically, you can find the recipes that build both Wayland
1360 and Weston at
1361 <filename>meta/recipes-graphics/wayland</filename>.
1362 </para>
1363
1364 <para>
1365 You can build both the Wayland and Weston packages for use only
1366 with targets that accept the
1367 <ulink url='https://en.wikipedia.org/wiki/Mesa_(computer_graphics)'>Mesa 3D and Direct Rendering Infrastructure</ulink>,
1368 which is also known as Mesa DRI.
1369 This implies that you cannot build and use the packages if your
1370 target uses, for example, the
1371 <trademark class='registered'>Intel</trademark> Embedded Media
1372 and Graphics Driver
1373 (<trademark class='registered'>Intel</trademark> EMGD) that
1374 overrides Mesa DRI.
1375 <note>
1376 Due to lack of EGL support, Weston 1.0.3 will not run
1377 directly on the emulated QEMU hardware.
1378 However, this version of Weston will run under X emulation
1379 without issues.
1380 </note>
1381 </para>
1382 </section>
1383
1384 <section id="enabling-wayland-in-an-image">
1385 <title>Enabling Wayland in an Image</title>
1386
1387 <para>
1388 To enable Wayland, you need to enable it to be built and enable
1389 it to be included in the image.
1390 </para>
1391
1392 <section id="enable-building">
1393 <title>Building</title>
1394
1395 <para>
1396 To cause Mesa to build the <filename>wayland-egl</filename>
1397 platform and Weston to build Wayland with Kernel Mode
1398 Setting
1399 (<ulink url='https://wiki.archlinux.org/index.php/Kernel_Mode_Setting'>KMS</ulink>)
1400 support, include the "wayland" flag in the
1401 <ulink url="&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES"><filename>DISTRO_FEATURES</filename></ulink>
1402 statement in your <filename>local.conf</filename> file:
1403 <literallayout class='monospaced'>
1404 DISTRO_FEATURES_append = " wayland"
1405 </literallayout>
1406 <note>
1407 If X11 has been enabled elsewhere, Weston will build
1408 Wayland with X11 support
1409 </note>
1410 </para>
1411 </section>
1412
1413 <section id="enable-installation-in-an-image">
1414 <title>Installing</title>
1415
1416 <para>
1417 To install the Wayland feature into an image, you must
1418 include the following
1419 <ulink url='&YOCTO_DOCS_REF_URL;#var-CORE_IMAGE_EXTRA_INSTALL'><filename>CORE_IMAGE_EXTRA_INSTALL</filename></ulink>
1420 statement in your <filename>local.conf</filename> file:
1421 <literallayout class='monospaced'>
1422 CORE_IMAGE_EXTRA_INSTALL += "wayland weston"
1423 </literallayout>
1424 </para>
1425 </section>
1426 </section>
1427
1428 <section id="running-weston">
1429 <title>Running Weston</title>
1430
1431 <para>
1432 To run Weston inside X11, enabling it as described earlier and
1433 building a Sato image is sufficient.
1434 If you are running your image under Sato, a Weston Launcher
1435 appears in the "Utility" category.
1436 </para>
1437
1438 <para>
1439 Alternatively, you can run Weston through the command-line
1440 interpretor (CLI), which is better suited for development work.
1441 To run Weston under the CLI, you need to do the following after
1442 your image is built:
1443 <orderedlist>
1444 <listitem><para>
1445 Run these commands to export
1446 <filename>XDG_RUNTIME_DIR</filename>:
1447 <literallayout class='monospaced'>
1448 mkdir -p /tmp/$USER-weston
1449 chmod 0700 /tmp/$USER-weston
1450 export XDG_RUNTIME_DIR=/tmp/$USER-weston
1451 </literallayout>
1452 </para></listitem>
1453 <listitem><para>
1454 Launch Weston in the shell:
1455 <literallayout class='monospaced'>
1456 weston
1457 </literallayout></para></listitem>
1458 </orderedlist>
1459 </para>
1460 </section>
1461 </section>
1462
1328 <section id='x32'> 1463 <section id='x32'>
1329 <title>x32 psABI</title> 1464 <title>x32 psABI</title>
1330 1465
diff --git a/documentation/ref-manual/ref-images.xml b/documentation/ref-manual/ref-images.xml
index c752f94c3d..fd6d5aabe9 100644
--- a/documentation/ref-manual/ref-images.xml
+++ b/documentation/ref-manual/ref-images.xml
@@ -151,7 +151,8 @@
151 This image provides the Wayland protocol libraries and the 151 This image provides the Wayland protocol libraries and the
152 reference Weston compositor. 152 reference Weston compositor.
153 For more information, see the 153 For more information, see the
154 "<link linkend='wayland'>Wayland</link>" section. 154 "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#wayland'>Wayland</ulink>"
155 section in the Yocto Project Overview Manual.
155 </para></listitem> 156 </para></listitem>
156 <listitem><para><filename>core-image-x11</filename>: 157 <listitem><para><filename>core-image-x11</filename>:
157 A very basic X11 image with a terminal. 158 A very basic X11 image with a terminal.
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
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2026-02-02 21:02:34 +0000