diff options
author | Tiago Vignatti <tiago.vignatti@intel.com> | 2012-11-13 19:28:47 -0200 |
---|---|---|
committer | Peter Hutterer <peter.hutterer@who-t.net> | 2013-04-03 14:06:55 +1000 |
commit | b8b4ff4af55467bade6af7390207c11df5980617 (patch) | |
tree | a916c7cf4f4fe631773f48b9a59cfe25f1f9e671 | |
parent | 3fc312b6ec086d42d201d4087c329d32ba1dfb3e (diff) |
doc: Improve "Library" chapter, moving "Types of Compositor" as its section
It was added a "Server API" section and "Types of Compositor" was moved there
also. I hope this gives a better structure for the documentation.
Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
-rw-r--r-- | doc/Wayland/en_US/Compositors.xml | 26 | ||||
-rw-r--r-- | doc/Wayland/en_US/Library.xml | 27 | ||||
-rw-r--r-- | doc/Wayland/en_US/Wayland.xml | 1 |
3 files changed, 50 insertions, 4 deletions
diff --git a/doc/Wayland/en_US/Compositors.xml b/doc/Wayland/en_US/Compositors.xml index d5311fa..cc727b2 100644 --- a/doc/Wayland/en_US/Compositors.xml +++ b/doc/Wayland/en_US/Compositors.xml @@ -3,8 +3,22 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Wayland.ent"> %BOOK_ENTITIES; ]> -<chapter id="chap-Compositors"> +<section id="sect-Compositors"> <title>Types of Compositors</title> + + <para> + Different types of compositors may exist on different systems. For + instance, a <emphasis>system compositor</emphasis> can be used for booting + the system, handling multiple user switching, a possible console + terminal emulator and so forth. A different compositor, a <emphasis>session + compositor</emphasis>, would provide the actual desktop environment. There + are many ways for different types of compositors to co-exist. + </para> + <para> + In this section, we introduce three types of Wayland compositors relying on + <emphasis>libwayland-server</emphasis>. + </para> + <section id="sect-Compositors-System-Compositor"> <title>System Compositor</title> <para> @@ -86,6 +100,12 @@ </listitem> <listitem> <para> + Weston with X11 or Wayland backend is a session compositor nested + in another session compositor. + </para> + </listitem> + <listitem> + <para> fullscreen X session under wayland </para> </listitem> @@ -97,7 +117,7 @@ </listitem> <listitem> <para> - root window less X server, bridging X windows into a wayland + root window-less X server, bridging X windows into a wayland session compositor </para> </listitem> @@ -135,4 +155,4 @@ </itemizedlist> </para> </section> -</chapter> +</section> diff --git a/doc/Wayland/en_US/Library.xml b/doc/Wayland/en_US/Library.xml index ab325d6..efe5597 100644 --- a/doc/Wayland/en_US/Library.xml +++ b/doc/Wayland/en_US/Library.xml @@ -5,5 +5,32 @@ ]> <chapter id="chap-Library"> <title>Wayland Library</title> + + <para> + The open-source reference implementation of Wayland protocol is split in two + C libraries, <emphasis>libwayland-server</emphasis> and + <emphasis>libwayland-client</emphasis>. Their main + responsibility is to handle the Inter-process communication + (<emphasis>IPC</emphasis>) with each other, therefore guaranteeing the + protocol objects marshaling and messages synchronization. + </para> + + <para> + This Chapter describes in detail each library's methods and their helpers, + aiming implementors who can use for building Wayland clients and servers; + respectively at <xref linkend="sect-Library-Client"/> and + <xref linkend="sect-Library-Server"/>. The last + <xref linkend="sect-Compositors"/>, gives an example how + <emphasis>libwayland-server</emphasis> can be used for building different + types of compositors. + </para> + <xi:include href="WaylandClientAPI.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + + <section id="sect-Library-Server"> + <title>Server API</title> + <para>TODO</para> + </section> + + <xi:include href="Compositors.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> </chapter> diff --git a/doc/Wayland/en_US/Wayland.xml b/doc/Wayland/en_US/Wayland.xml index e240512..845634b 100644 --- a/doc/Wayland/en_US/Wayland.xml +++ b/doc/Wayland/en_US/Wayland.xml @@ -11,7 +11,6 @@ <xi:include href="Architecture.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Protocol.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Library.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Compositors.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="ProtocolSpec.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </book> |