summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-06-07 19:42:16 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-06-14 17:33:31 +0100
commit1ff4961788c2211286c8380a367ed49afe84ee13 (patch)
tree0c822d73aa31374840e8143513c64639b6ed38df /documentation
parent31c52bb7ac2511f6a3b9b7e73b2e611fa3f5ee64 (diff)
downloadpoky-1ff4961788c2211286c8380a367ed49afe84ee13.tar.gz
ref-manual: Wayland section review draft
Fixes YOCTO #3882 This is the review draft for the wayland section. (From yocto-docs rev: 54234dae5c2957ef2c1a6cb03a7e7fe0fa2cea34) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/technical-details.xml52
1 files changed, 37 insertions, 15 deletions
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml
index 6f36a3a0fa..0634f5702d 100644
--- a/documentation/ref-manual/technical-details.xml
+++ b/documentation/ref-manual/technical-details.xml
@@ -743,23 +743,45 @@
743 <title>Enabling Wayland in an Image</title> 743 <title>Enabling Wayland in an Image</title>
744 744
745 <para> 745 <para>
746 This section talks about two different ways to enable Wayland: 746 To enable Wayland, you need to enable it to be built and enable
747 to run under X11 (the default), or to run under Kernel Mode 747 it to be included in the image.
748 Setting (<ulink url='https://wiki.archlinux.org/index.php/Kernel_Mode_Setting'>KMS</ulink>).
749 </para> 748 </para>
750 749
751 <para> 750 <section id="enable-building">
752 I don't clearly understand the steps as they are described in the 751 <title>Building</title>
753 <ulink url='https://wiki.yoctoproject.org/wiki/Wayland'>Enable Wayland in an Image</ulink> 752
754 section of the wiki. 753 <para>
755 I need help in understanding this section before I can complete 754 To cause Mesa to build the <filename>wayland-egl</filename>
756 this first draft of the new section. 755 platform and Weston to build Wayland with Kernel Mode
757 What I don't understand is what you have to do exactly for each 756 Setting
758 method. 757 (<ulink url='https://wiki.archlinux.org/index.php/Kernel_Mode_Setting'>KMS</ulink>)
759 The description in the wiki implies that you need to append the 758 support, include the "wayland" flag in the
760 "wayland" feature to use KMS/DRI as well as X11 (both). 759 <link linkend="var-DISTRO_FEATURES"><filename>DISTRO_FEATURES</filename></link>
761 I need some clarification and clearer steps for the user. 760 statement in your <filename>local.conf</filename> file:
762 </para> 761 <literallayout class='monospaced'>
762 DISTRO_FEATURES_append = " wayland"
763 </literallayout>
764 </para>
765
766 <note>
767 If X11 has been enabled elsewhere, Weston will build Wayland
768 with X11 support
769 </note>
770 </section>
771
772 <section id="enable-installation-in-an-image">
773 <title>Installing</title>
774
775 <para>
776 To install the Wayland feature into an image, you must
777 include the following
778 <link linkend='var-CORE_IMAGE_EXTRA_INSTALL'><filename>CORE_IMAGE_EXTRA_INSTALL</filename></link>
779 statement in your <filename>local.conf</filename> file:
780 <literallayout class='monospaced'>
781 CORE_IMAGE_EXTRA_INSTALL += "wayland weston"
782 </literallayout>
783 </para>
784 </section>
763 </section> 785 </section>
764 786
765 <section id="running-weston"> 787 <section id="running-weston">