mirror of
https://git.yoctoproject.org/poky
synced 2026-05-31 12:49:46 +00:00
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>
This commit is contained in:
Scott Rifenbark
committed by
Richard Purdie
Richard Purdie
parent
99980546fa
commit
16e417be63
@@ -1325,6 +1325,141 @@
|
|||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
<section id="wayland">
|
||||||
|
<title>Wayland</title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
<ulink url='http://en.wikipedia.org/wiki/Wayland_(display_server_protocol)'>Wayland</ulink>
|
||||||
|
is a computer display server protocol that
|
||||||
|
provides a method for compositing window managers to communicate
|
||||||
|
directly with applications and video hardware and expects them to
|
||||||
|
communicate with input hardware using other libraries.
|
||||||
|
Using Wayland with supporting targets can result in better control
|
||||||
|
over graphics frame rendering than an application might otherwise
|
||||||
|
achieve.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
The Yocto Project provides the Wayland protocol libraries and the
|
||||||
|
reference
|
||||||
|
<ulink url='http://en.wikipedia.org/wiki/Wayland_(display_server_protocol)#Weston'>Weston</ulink>
|
||||||
|
compositor as part of its release.
|
||||||
|
This section describes what you need to do to implement Wayland and
|
||||||
|
use the compositor when building an image for a supporting target.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<section id="wayland-support">
|
||||||
|
<title>Support</title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
The Wayland protocol libraries and the reference Weston
|
||||||
|
compositor ship as integrated packages in the
|
||||||
|
<filename>meta</filename> layer of the
|
||||||
|
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.
|
||||||
|
Specifically, you can find the recipes that build both Wayland
|
||||||
|
and Weston at
|
||||||
|
<filename>meta/recipes-graphics/wayland</filename>.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
You can build both the Wayland and Weston packages for use only
|
||||||
|
with targets that accept the
|
||||||
|
<ulink url='https://en.wikipedia.org/wiki/Mesa_(computer_graphics)'>Mesa 3D and Direct Rendering Infrastructure</ulink>,
|
||||||
|
which is also known as Mesa DRI.
|
||||||
|
This implies that you cannot build and use the packages if your
|
||||||
|
target uses, for example, the
|
||||||
|
<trademark class='registered'>Intel</trademark> Embedded Media
|
||||||
|
and Graphics Driver
|
||||||
|
(<trademark class='registered'>Intel</trademark> EMGD) that
|
||||||
|
overrides Mesa DRI.
|
||||||
|
<note>
|
||||||
|
Due to lack of EGL support, Weston 1.0.3 will not run
|
||||||
|
directly on the emulated QEMU hardware.
|
||||||
|
However, this version of Weston will run under X emulation
|
||||||
|
without issues.
|
||||||
|
</note>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section id="enabling-wayland-in-an-image">
|
||||||
|
<title>Enabling Wayland in an Image</title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
To enable Wayland, you need to enable it to be built and enable
|
||||||
|
it to be included in the image.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<section id="enable-building">
|
||||||
|
<title>Building</title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
To cause Mesa to build the <filename>wayland-egl</filename>
|
||||||
|
platform and Weston to build Wayland with Kernel Mode
|
||||||
|
Setting
|
||||||
|
(<ulink url='https://wiki.archlinux.org/index.php/Kernel_Mode_Setting'>KMS</ulink>)
|
||||||
|
support, include the "wayland" flag in the
|
||||||
|
<ulink url="&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES"><filename>DISTRO_FEATURES</filename></ulink>
|
||||||
|
statement in your <filename>local.conf</filename> file:
|
||||||
|
<literallayout class='monospaced'>
|
||||||
|
DISTRO_FEATURES_append = " wayland"
|
||||||
|
</literallayout>
|
||||||
|
<note>
|
||||||
|
If X11 has been enabled elsewhere, Weston will build
|
||||||
|
Wayland with X11 support
|
||||||
|
</note>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section id="enable-installation-in-an-image">
|
||||||
|
<title>Installing</title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
To install the Wayland feature into an image, you must
|
||||||
|
include the following
|
||||||
|
<ulink url='&YOCTO_DOCS_REF_URL;#var-CORE_IMAGE_EXTRA_INSTALL'><filename>CORE_IMAGE_EXTRA_INSTALL</filename></ulink>
|
||||||
|
statement in your <filename>local.conf</filename> file:
|
||||||
|
<literallayout class='monospaced'>
|
||||||
|
CORE_IMAGE_EXTRA_INSTALL += "wayland weston"
|
||||||
|
</literallayout>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section id="running-weston">
|
||||||
|
<title>Running Weston</title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
To run Weston inside X11, enabling it as described earlier and
|
||||||
|
building a Sato image is sufficient.
|
||||||
|
If you are running your image under Sato, a Weston Launcher
|
||||||
|
appears in the "Utility" category.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
Alternatively, you can run Weston through the command-line
|
||||||
|
interpretor (CLI), which is better suited for development work.
|
||||||
|
To run Weston under the CLI, you need to do the following after
|
||||||
|
your image is built:
|
||||||
|
<orderedlist>
|
||||||
|
<listitem><para>
|
||||||
|
Run these commands to export
|
||||||
|
<filename>XDG_RUNTIME_DIR</filename>:
|
||||||
|
<literallayout class='monospaced'>
|
||||||
|
mkdir -p /tmp/$USER-weston
|
||||||
|
chmod 0700 /tmp/$USER-weston
|
||||||
|
export XDG_RUNTIME_DIR=/tmp/$USER-weston
|
||||||
|
</literallayout>
|
||||||
|
</para></listitem>
|
||||||
|
<listitem><para>
|
||||||
|
Launch Weston in the shell:
|
||||||
|
<literallayout class='monospaced'>
|
||||||
|
weston
|
||||||
|
</literallayout></para></listitem>
|
||||||
|
</orderedlist>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
<section id='x32'>
|
<section id='x32'>
|
||||||
<title>x32 psABI</title>
|
<title>x32 psABI</title>
|
||||||
|
|
||||||
|
|||||||
@@ -151,7 +151,8 @@
|
|||||||
This image provides the Wayland protocol libraries and the
|
This image provides the Wayland protocol libraries and the
|
||||||
reference Weston compositor.
|
reference Weston compositor.
|
||||||
For more information, see the
|
For more information, see the
|
||||||
"<link linkend='wayland'>Wayland</link>" section.
|
"<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#wayland'>Wayland</ulink>"
|
||||||
|
section in the Yocto Project Overview Manual.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><filename>core-image-x11</filename>:
|
<listitem><para><filename>core-image-x11</filename>:
|
||||||
A very basic X11 image with a terminal.
|
A very basic X11 image with a terminal.
|
||||||
|
|||||||
@@ -13,138 +13,6 @@
|
|||||||
x32, Wayland support, and Licenses.
|
x32, Wayland support, and Licenses.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<section id="wayland">
|
|
||||||
<title>Wayland</title>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
<ulink url='http://en.wikipedia.org/wiki/Wayland_(display_server_protocol)'>Wayland</ulink>
|
|
||||||
is a computer display server protocol that
|
|
||||||
provides a method for compositing window managers to communicate
|
|
||||||
directly with applications and video hardware and expects them to
|
|
||||||
communicate with input hardware using other libraries.
|
|
||||||
Using Wayland with supporting targets can result in better control
|
|
||||||
over graphics frame rendering than an application might otherwise
|
|
||||||
achieve.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
The Yocto Project provides the Wayland protocol libraries and the
|
|
||||||
reference
|
|
||||||
<ulink url='http://en.wikipedia.org/wiki/Wayland_(display_server_protocol)#Weston'>Weston</ulink>
|
|
||||||
compositor as part of its release.
|
|
||||||
This section describes what you need to do to implement Wayland and
|
|
||||||
use the compositor when building an image for a supporting target.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<section id="wayland-support">
|
|
||||||
<title>Support</title>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
The Wayland protocol libraries and the reference Weston compositor
|
|
||||||
ship as integrated packages in the <filename>meta</filename> layer
|
|
||||||
of the
|
|
||||||
<link linkend='source-directory'>Source Directory</link>.
|
|
||||||
Specifically, you can find the recipes that build both Wayland
|
|
||||||
and Weston at <filename>meta/recipes-graphics/wayland</filename>.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
You can build both the Wayland and Weston packages for use only
|
|
||||||
with targets that accept the
|
|
||||||
<ulink url='http://dri.freedesktop.org/wiki/'>Mesa 3D and Direct Rendering Infrastructure</ulink>,
|
|
||||||
which is also known as Mesa DRI.
|
|
||||||
This implies that you cannot build and use the packages if your
|
|
||||||
target uses, for example, the
|
|
||||||
<trademark class='registered'>Intel</trademark> Embedded Media and
|
|
||||||
Graphics Driver (<trademark class='registered'>Intel</trademark>
|
|
||||||
EMGD) that overrides Mesa DRI.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<note>
|
|
||||||
Due to lack of EGL support, Weston 1.0.3 will not run directly on
|
|
||||||
the emulated QEMU hardware.
|
|
||||||
However, this version of Weston will run under X emulation without
|
|
||||||
issues.
|
|
||||||
</note>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="enabling-wayland-in-an-image">
|
|
||||||
<title>Enabling Wayland in an Image</title>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
To enable Wayland, you need to enable it to be built and enable
|
|
||||||
it to be included in the image.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<section id="enable-building">
|
|
||||||
<title>Building</title>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
To cause Mesa to build the <filename>wayland-egl</filename>
|
|
||||||
platform and Weston to build Wayland with Kernel Mode
|
|
||||||
Setting
|
|
||||||
(<ulink url='https://wiki.archlinux.org/index.php/Kernel_Mode_Setting'>KMS</ulink>)
|
|
||||||
support, include the "wayland" flag in the
|
|
||||||
<link linkend="var-DISTRO_FEATURES"><filename>DISTRO_FEATURES</filename></link>
|
|
||||||
statement in your <filename>local.conf</filename> file:
|
|
||||||
<literallayout class='monospaced'>
|
|
||||||
DISTRO_FEATURES_append = " wayland"
|
|
||||||
</literallayout>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<note>
|
|
||||||
If X11 has been enabled elsewhere, Weston will build Wayland
|
|
||||||
with X11 support
|
|
||||||
</note>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="enable-installation-in-an-image">
|
|
||||||
<title>Installing</title>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
To install the Wayland feature into an image, you must
|
|
||||||
include the following
|
|
||||||
<link linkend='var-CORE_IMAGE_EXTRA_INSTALL'><filename>CORE_IMAGE_EXTRA_INSTALL</filename></link>
|
|
||||||
statement in your <filename>local.conf</filename> file:
|
|
||||||
<literallayout class='monospaced'>
|
|
||||||
CORE_IMAGE_EXTRA_INSTALL += "wayland weston"
|
|
||||||
</literallayout>
|
|
||||||
</para>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="running-weston">
|
|
||||||
<title>Running Weston</title>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
To run Weston inside X11, enabling it as described earlier and
|
|
||||||
building a Sato image is sufficient.
|
|
||||||
If you are running your image under Sato, a Weston Launcher appears
|
|
||||||
in the "Utility" category.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
Alternatively, you can run Weston through the command-line
|
|
||||||
interpretor (CLI), which is better suited for development work.
|
|
||||||
To run Weston under the CLI, you need to do the following after
|
|
||||||
your image is built:
|
|
||||||
<orderedlist>
|
|
||||||
<listitem><para>Run these commands to export
|
|
||||||
<filename>XDG_RUNTIME_DIR</filename>:
|
|
||||||
<literallayout class='monospaced'>
|
|
||||||
mkdir -p /tmp/$USER-weston
|
|
||||||
chmod 0700 /tmp/$USER-weston
|
|
||||||
export XDG_RUNTIME_DIR=/tmp/$USER-weston
|
|
||||||
</literallayout></para></listitem>
|
|
||||||
<listitem><para>Launch Weston in the shell:
|
|
||||||
<literallayout class='monospaced'>
|
|
||||||
weston
|
|
||||||
</literallayout></para></listitem>
|
|
||||||
</orderedlist>
|
|
||||||
</para>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="licenses">
|
<section id="licenses">
|
||||||
<title>Licenses</title>
|
<title>Licenses</title>
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user