From ecdd2ec8f47f8f32d3d7c1d83687db65e0801401 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 29 May 2013 14:13:03 +0300 Subject: ref-manual: Partial draft for the new Wayland support section. I created a partial draft of the new section that describes how to use the wayland feature. (From yocto-docs rev: 1b4a421b8984d6fa740ab2bcaa0fb167b6d528fa) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/technical-details.xml | 110 ++++++++++++++++++++++++- 1 file changed, 109 insertions(+), 1 deletion(-) (limited to 'documentation') diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml index 34d7847f22..6f36a3a0fa 100644 --- a/documentation/ref-manual/technical-details.xml +++ b/documentation/ref-manual/technical-details.xml @@ -641,7 +641,7 @@ Stabilizing and Completing x32 - As of this Yocto Project release, the x32 psABI kernel and library + As of this Yocto Project release, the x32 psABI kernel and library interfaces specifications are not finalized. @@ -686,6 +686,114 @@ +
+ Wayland + + + Wayland + is a computer display server protocol that when implemented + 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. + + + + The Yocto Project provides the Wayland protocol libraries and the + reference Weston compositor as part of it release. + This section describes what you need to do to implement Wayland and + use the compositor when building an image for a supporting target. + + +
+ Support + + + The Wayland protocol libraries and the reference Weston compositor + ship as integrated packages in the meta layer + of the + Source Directory. + Specifically, you can find the recipes that build both Wayland + and Weston at meta/recipes-graphics/wayland. + + + + You can build both the Wayland and Weston packages for use only + with targets that accept the + Mesa 3D and Direct Rendering Infrastructure, + which is also known as Mesa DRI. + This implies that you cannot build and use the packages if your + target uses, for example, the + Intel Embedded Media and + Graphics Driver (Intel + EMGD) that overrides Mesa DRI. + + + + 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. + +
+ +
+ Enabling Wayland in an Image + + + This section talks about two different ways to enable Wayland: + to run under X11 (the default), or to run under Kernel Mode + Setting (KMS). + + + + I don't clearly understand the steps as they are described in the + Enable Wayland in an Image + section of the wiki. + I need help in understanding this section before I can complete + this first draft of the new section. + What I don't understand is what you have to do exactly for each + method. + The description in the wiki implies that you need to append the + "wayland" feature to use KMS/DRI as well as X11 (both). + I need some clarification and clearer steps for the user. + +
+ +
+ Running Weston + + + 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. + + + + 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: + + Run these commands to export + XDG_RUNTIME_DIR: + + mkdir -p /tmp/$USER-weston + chmod 0700 /tmp/$USER-weston + export XDG_RUNTIME_DIR=/tmp/$USER=weston + + Launch Weston in the shell: + + weston + + + +
+
+
Licenses -- cgit v1.2.3-54-g00ecf