summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-05-29 14:13:03 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-05-31 08:19:21 +0100
commit2944e0738336edb66d5272fa2e38b382ec101193 (patch)
tree3b61594eb0228eb6fef535f30e5498ec15cb5ee0 /documentation/ref-manual
parentafc4aec1d5449837cb42216c4068164e6aa00c65 (diff)
downloadpoky-2944e0738336edb66d5272fa2e38b382ec101193.tar.gz
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: a03d1897a39ee2eb0fbb551c66c63b10928aebc4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/technical-details.xml110
1 files changed, 109 insertions, 1 deletions
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 @@
641 <title>Stabilizing and Completing x32</title> 641 <title>Stabilizing and Completing x32</title>
642 642
643 <para> 643 <para>
644 As of this Yocto Project release, the x32 psABI kernel and library 644 As of this Yocto Project release, the x32 psABI kernel and library
645 interfaces specifications are not finalized. 645 interfaces specifications are not finalized.
646 </para> 646 </para>
647 647
@@ -686,6 +686,114 @@
686 </section> 686 </section>
687</section> 687</section>
688 688
689<section id="wayland">
690 <title>Wayland</title>
691
692 <para>
693 <ulink url='http://en.wikipedia.org/wiki/Wayland_(display_server_protocol)#Weston'>Wayland</ulink>
694 is a computer display server protocol that when implemented
695 provides a method for compositing window managers to communicate
696 directly with applications and video hardware and expects them to
697 communicate with input hardware using other libraries.
698 Using Wayland with supporting targets can result in better control
699 over graphics frame rendering than an application might otherwise
700 achieve.
701 </para>
702
703 <para>
704 The Yocto Project provides the Wayland protocol libraries and the
705 reference Weston compositor as part of it release.
706 This section describes what you need to do to implement Wayland and
707 use the compositor when building an image for a supporting target.
708 </para>
709
710 <section id="wayland-support">
711 <title>Support</title>
712
713 <para>
714 The Wayland protocol libraries and the reference Weston compositor
715 ship as integrated packages in the <filename>meta</filename> layer
716 of the
717 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
718 Specifically, you can find the recipes that build both Wayland
719 and Weston at <filename>meta/recipes-graphics/wayland</filename>.
720 </para>
721
722 <para>
723 You can build both the Wayland and Weston packages for use only
724 with targets that accept the
725 <ulink url='http://dri.freedesktop.org/wiki/'>Mesa 3D and Direct Rendering Infrastructure</ulink>,
726 which is also known as Mesa DRI.
727 This implies that you cannot build and use the packages if your
728 target uses, for example, the
729 <trademark class='registered'>Intel</trademark> Embedded Media and
730 Graphics Driver (<trademark class='registered'>Intel</trademark>
731 EMGD) that overrides Mesa DRI.
732 </para>
733
734 <note>
735 Due to lack of EGL support, Weston 1.0.3 will not run directly on
736 the emulated QEMU hardware.
737 However, this version of Weston will run under X emulation without
738 issues.
739 </note>
740 </section>
741
742 <section id="enabling-wayland-in-an-image">
743 <title>Enabling Wayland in an Image</title>
744
745 <para>
746 This section talks about two different ways to enable Wayland:
747 to run under X11 (the default), or to run under Kernel Mode
748 Setting (<ulink url='https://wiki.archlinux.org/index.php/Kernel_Mode_Setting'>KMS</ulink>).
749 </para>
750
751 <para>
752 I don't clearly understand the steps as they are described in the
753 <ulink url='https://wiki.yoctoproject.org/wiki/Wayland'>Enable Wayland in an Image</ulink>
754 section of the wiki.
755 I need help in understanding this section before I can complete
756 this first draft of the new section.
757 What I don't understand is what you have to do exactly for each
758 method.
759 The description in the wiki implies that you need to append the
760 "wayland" feature to use KMS/DRI as well as X11 (both).
761 I need some clarification and clearer steps for the user.
762 </para>
763 </section>
764
765 <section id="running-weston">
766 <title>Running Weston</title>
767
768 <para>
769 To run Weston inside X11, enabling it as described earlier and
770 building a Sato image is sufficient.
771 If you are running your image under Sato, a Weston Launcher appears
772 in the "Utility" category.
773 </para>
774
775 <para>
776 Alternatively, you can run Weston through the command-line
777 interpretor (CLI), which is better suited for development work.
778 To run Weston under the CLI you need to do the following after
779 your image is built:
780 <orderedlist>
781 <listitem><para>Run these commands to export
782 <filename>XDG_RUNTIME_DIR</filename>:
783 <literallayout class='monospaced'>
784 mkdir -p /tmp/$USER-weston
785 chmod 0700 /tmp/$USER-weston
786 export XDG_RUNTIME_DIR=/tmp/$USER=weston
787 </literallayout></para></listitem>
788 <listitem><para>Launch Weston in the shell:
789 <literallayout class='monospaced'>
790 weston
791 </literallayout></para></listitem>
792 </orderedlist>
793 </para>
794 </section>
795</section>
796
689<section id="licenses"> 797<section id="licenses">
690 <title>Licenses</title> 798 <title>Licenses</title>
691 799