diff options
| author | Scott Rifenbark <srifenbark@gmail.com> | 2018-05-14 14:33:45 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-05-24 17:16:34 +0100 |
| commit | 88c6050ad28229231965017b64de40b086e6b4d1 (patch) | |
| tree | c1994306c27fd5e344eea136fef99127d4d593b1 /documentation/overview-manual | |
| parent | c72b126bc0dc8377998988905b4311a10f0d3a8b (diff) | |
| download | poky-88c6050ad28229231965017b64de40b086e6b4d1.tar.gz | |
overview-manual, dev-manual: Moved Wayland and Weston
The Wayland and Weston topic moved from the overview-manual to
the dev-manual. The topic was really a "how-to" topic and not
a concepts topic.
(From yocto-docs rev: b0f20a67c99590c48d595f4e572339bb5b6b83b3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/overview-manual')
| -rw-r--r-- | documentation/overview-manual/overview-manual-concepts.xml | 135 |
1 files changed, 0 insertions, 135 deletions
diff --git a/documentation/overview-manual/overview-manual-concepts.xml b/documentation/overview-manual/overview-manual-concepts.xml index af34b970aa..9f0f9d1d9f 100644 --- a/documentation/overview-manual/overview-manual-concepts.xml +++ b/documentation/overview-manual/overview-manual-concepts.xml | |||
| @@ -3227,141 +3227,6 @@ | |||
| 3227 | </para> | 3227 | </para> |
| 3228 | </section> | 3228 | </section> |
| 3229 | 3229 | ||
| 3230 | <section id="wayland"> | ||
| 3231 | <title>Wayland</title> | ||
| 3232 | |||
| 3233 | <para> | ||
| 3234 | <ulink url='http://en.wikipedia.org/wiki/Wayland_(display_server_protocol)'>Wayland</ulink> | ||
| 3235 | is a computer display server protocol that | ||
| 3236 | provides a method for compositing window managers to communicate | ||
| 3237 | directly with applications and video hardware and expects them to | ||
| 3238 | communicate with input hardware using other libraries. | ||
| 3239 | Using Wayland with supporting targets can result in better control | ||
| 3240 | over graphics frame rendering than an application might otherwise | ||
| 3241 | achieve. | ||
| 3242 | </para> | ||
| 3243 | |||
| 3244 | <para> | ||
| 3245 | The Yocto Project provides the Wayland protocol libraries and the | ||
| 3246 | reference | ||
| 3247 | <ulink url='http://en.wikipedia.org/wiki/Wayland_(display_server_protocol)#Weston'>Weston</ulink> | ||
| 3248 | compositor as part of its release. | ||
| 3249 | This section describes what you need to do to implement Wayland and | ||
| 3250 | use the compositor when building an image for a supporting target. | ||
| 3251 | </para> | ||
| 3252 | |||
| 3253 | <section id="wayland-support"> | ||
| 3254 | <title>Support</title> | ||
| 3255 | |||
| 3256 | <para> | ||
| 3257 | The Wayland protocol libraries and the reference Weston | ||
| 3258 | compositor ship as integrated packages in the | ||
| 3259 | <filename>meta</filename> layer of the | ||
| 3260 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>. | ||
| 3261 | Specifically, you can find the recipes that build both Wayland | ||
| 3262 | and Weston at | ||
| 3263 | <filename>meta/recipes-graphics/wayland</filename>. | ||
| 3264 | </para> | ||
| 3265 | |||
| 3266 | <para> | ||
| 3267 | You can build both the Wayland and Weston packages for use only | ||
| 3268 | with targets that accept the | ||
| 3269 | <ulink url='https://en.wikipedia.org/wiki/Mesa_(computer_graphics)'>Mesa 3D and Direct Rendering Infrastructure</ulink>, | ||
| 3270 | which is also known as Mesa DRI. | ||
| 3271 | This implies that you cannot build and use the packages if your | ||
| 3272 | target uses, for example, the | ||
| 3273 | <trademark class='registered'>Intel</trademark> Embedded Media | ||
| 3274 | and Graphics Driver | ||
| 3275 | (<trademark class='registered'>Intel</trademark> EMGD) that | ||
| 3276 | overrides Mesa DRI. | ||
| 3277 | <note> | ||
| 3278 | Due to lack of EGL support, Weston 1.0.3 will not run | ||
| 3279 | directly on the emulated QEMU hardware. | ||
| 3280 | However, this version of Weston will run under X emulation | ||
| 3281 | without issues. | ||
| 3282 | </note> | ||
| 3283 | </para> | ||
| 3284 | </section> | ||
| 3285 | |||
| 3286 | <section id="enabling-wayland-in-an-image"> | ||
| 3287 | <title>Enabling Wayland in an Image</title> | ||
| 3288 | |||
| 3289 | <para> | ||
| 3290 | To enable Wayland, you need to enable it to be built and enable | ||
| 3291 | it to be included in the image. | ||
| 3292 | </para> | ||
| 3293 | |||
| 3294 | <section id="enable-building"> | ||
| 3295 | <title>Building</title> | ||
| 3296 | |||
| 3297 | <para> | ||
| 3298 | To cause Mesa to build the <filename>wayland-egl</filename> | ||
| 3299 | platform and Weston to build Wayland with Kernel Mode | ||
| 3300 | Setting | ||
| 3301 | (<ulink url='https://wiki.archlinux.org/index.php/Kernel_Mode_Setting'>KMS</ulink>) | ||
| 3302 | support, include the "wayland" flag in the | ||
| 3303 | <ulink url="&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES"><filename>DISTRO_FEATURES</filename></ulink> | ||
| 3304 | statement in your <filename>local.conf</filename> file: | ||
| 3305 | <literallayout class='monospaced'> | ||
| 3306 | DISTRO_FEATURES_append = " wayland" | ||
| 3307 | </literallayout> | ||
| 3308 | <note> | ||
| 3309 | If X11 has been enabled elsewhere, Weston will build | ||
| 3310 | Wayland with X11 support | ||
| 3311 | </note> | ||
| 3312 | </para> | ||
| 3313 | </section> | ||
| 3314 | |||
| 3315 | <section id="enable-installation-in-an-image"> | ||
| 3316 | <title>Installing</title> | ||
| 3317 | |||
| 3318 | <para> | ||
| 3319 | To install the Wayland feature into an image, you must | ||
| 3320 | include the following | ||
| 3321 | <ulink url='&YOCTO_DOCS_REF_URL;#var-CORE_IMAGE_EXTRA_INSTALL'><filename>CORE_IMAGE_EXTRA_INSTALL</filename></ulink> | ||
| 3322 | statement in your <filename>local.conf</filename> file: | ||
| 3323 | <literallayout class='monospaced'> | ||
| 3324 | CORE_IMAGE_EXTRA_INSTALL += "wayland weston" | ||
| 3325 | </literallayout> | ||
| 3326 | </para> | ||
| 3327 | </section> | ||
| 3328 | </section> | ||
| 3329 | |||
| 3330 | <section id="running-weston"> | ||
| 3331 | <title>Running Weston</title> | ||
| 3332 | |||
| 3333 | <para> | ||
| 3334 | To run Weston inside X11, enabling it as described earlier and | ||
| 3335 | building a Sato image is sufficient. | ||
| 3336 | If you are running your image under Sato, a Weston Launcher | ||
| 3337 | appears in the "Utility" category. | ||
| 3338 | </para> | ||
| 3339 | |||
| 3340 | <para> | ||
| 3341 | Alternatively, you can run Weston through the command-line | ||
| 3342 | interpretor (CLI), which is better suited for development work. | ||
| 3343 | To run Weston under the CLI, you need to do the following after | ||
| 3344 | your image is built: | ||
| 3345 | <orderedlist> | ||
| 3346 | <listitem><para> | ||
| 3347 | Run these commands to export | ||
| 3348 | <filename>XDG_RUNTIME_DIR</filename>: | ||
| 3349 | <literallayout class='monospaced'> | ||
| 3350 | mkdir -p /tmp/$USER-weston | ||
| 3351 | chmod 0700 /tmp/$USER-weston | ||
| 3352 | export XDG_RUNTIME_DIR=/tmp/$USER-weston | ||
| 3353 | </literallayout> | ||
| 3354 | </para></listitem> | ||
| 3355 | <listitem><para> | ||
| 3356 | Launch Weston in the shell: | ||
| 3357 | <literallayout class='monospaced'> | ||
| 3358 | weston | ||
| 3359 | </literallayout></para></listitem> | ||
| 3360 | </orderedlist> | ||
| 3361 | </para> | ||
| 3362 | </section> | ||
| 3363 | </section> | ||
| 3364 | |||
| 3365 | <section id="overview-licenses"> | 3230 | <section id="overview-licenses"> |
| 3366 | <title>Licenses</title> | 3231 | <title>Licenses</title> |
| 3367 | 3232 | ||
