summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2012-03-29 10:50:12 +1000
committerKristian Høgsberg <krh@bitplanet.net>2012-03-28 23:05:32 -0400
commit966e8ec9c0f8b46c28935bf3d5e7e84fe09b85ab (patch)
tree2a2cac57e11ea39bbfb9d135af7082374fb4bb41 /doc
parentadf300dc135bd1467ee89b0145f391a26e4c531e (diff)
doc: rename Procotol to ProtocolSpec and WaylandProtocol to Protocol
The former is the actual specification, the latter notes about the protocol. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'doc')
-rw-r--r--doc/Wayland/Makefile.am12
-rw-r--r--doc/Wayland/en_US/Protocol.xml (renamed from doc/Wayland/en_US/WaylandProtocol.xml)40
-rw-r--r--doc/Wayland/en_US/Wayland.xml4
-rw-r--r--doc/Wayland/protocol-to-docbook.xsl4
4 files changed, 30 insertions, 30 deletions
diff --git a/doc/Wayland/Makefile.am b/doc/Wayland/Makefile.am
index c9ee509..ae68d73 100644
--- a/doc/Wayland/Makefile.am
+++ b/doc/Wayland/Makefile.am
@@ -8,7 +8,7 @@ publican_sources = \
$(srcdir)/en_US/Author_Group.xml \
$(srcdir)/en_US/Book_Info.xml \
$(srcdir)/en_US/Wayland.xml \
- $(srcdir)/en_US/WaylandProtocol.xml \
+ $(srcdir)/en_US/Protocol.xml \
$(srcdir)/en_US/Compositors.xml \
$(srcdir)/en_US/Overview.xml \
$(srcdir)/en_US/images/icon.svg \
@@ -17,18 +17,18 @@ publican_sources = \
$(srcdir)/en_US/images/x-architecture.png
publican_targets = $(publican_sources:$(srcdir)/en_US%=$(builddir)/en-US%) \
- en-US/Protocol.xml
+ en-US/ProtocolSpec.xml
# The Protocol.xml is purely generated and required before running publican
-en-US/Protocol.xml: $(top_srcdir)/protocol/wayland.xml $(srcdir)/protocol-to-docbook.xsl
+en-US/ProtocolSpec.xml: $(top_srcdir)/protocol/wayland.xml $(srcdir)/protocol-to-docbook.xsl
$(AM_V_GEN)$(MKDIR_P) en-US/images
$(AM_V_GEN)$(XSLTPROC) $(srcdir)/protocol-to-docbook.xsl \
- $(top_srcdir)/protocol/wayland.xml > en-US/Protocol.xml
+ $(top_srcdir)/protocol/wayland.xml > en-US/ProtocolSpec.xml
# Copy the en_US source files into en-US destination
# This is required for out-of-source-tree build as publican does not allow us
# to specify the location of the source code.
-$(builddir)/en-US/%: $(srcdir)/en_US/% en-US/Protocol.xml $(publican_sources)
+$(builddir)/en-US/%: $(srcdir)/en_US/% en-US/ProtocolSpec.xml $(publican_sources)
$(AM_V_GEN)cp -f $< $@
# Run publican for the builddir on the generated (or copied) source
@@ -37,7 +37,7 @@ Wayland: $(publican_targets)
$(AM_V_GEN)$(PUBLICAN) build --lang en-US --format html,pdf \
--config $(srcdir)/publican.cfg
-CLEANFILES = en-US/Protocol.xml $(publican_targets)
+CLEANFILES = en-US/ProtocolSpec.xml $(publican_targets)
clean-local:
$(AM_V_at)rm -fr en-US
diff --git a/doc/Wayland/en_US/WaylandProtocol.xml b/doc/Wayland/en_US/Protocol.xml
index f31bdfe..3a4172b 100644
--- a/doc/Wayland/en_US/WaylandProtocol.xml
+++ b/doc/Wayland/en_US/Protocol.xml
@@ -3,9 +3,9 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "Wayland.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Wayland-Protocol">
+<chapter id="chap-Protocol">
<title>The Wayland Protocol</title>
- <section id="sect-Wayland-Protocol-Basic-Principles">
+ <section id="sect-Protocol-Basic-Principles">
<title>Basic Principles</title>
<para>
The wayland protocol is an asynchronous object oriented protocol. All
@@ -41,7 +41,7 @@
</itemizedlist>
</para>
</section>
- <section id="sect-Wayland-Protocol-Code-Generation">
+ <section id="sect-Protocol-Code-Generation">
<title>Code Generation</title>
<para>
The interfaces, requests and events are defined in
@@ -56,7 +56,7 @@
own stubs for the protocol entry points from the xml.
</para>
</section>
- <section id="sect-Wayland-Protocol-Wire-Format">
+ <section id="sect-Protocol-Wire-Format">
<title>Wire Format</title>
<para>
The protocol is sent over a UNIX domain stream socket. Currently, the
@@ -151,7 +151,7 @@
</variablelist>
</para>
</section>
- <section id="sect-Wayland-Protocol-Interfaces">
+ <section id="sect-Protocol-Interfaces">
<title>Interfaces</title>
<para>
The protocol includes several interfaces which are used for
@@ -276,7 +276,7 @@
</variablelist>
</para>
</section>
- <section id="sect-Wayland-Protocol-Connect-Time">
+ <section id="sect-Protocol-Connect-Time">
<title>Connect Time</title>
<para>
<itemizedlist>
@@ -295,7 +295,7 @@
</itemizedlist>
</para>
</section>
- <section id="sect-Wayland-Protocol-Security-and-Authentication">
+ <section id="sect-Protocol-Security-and-Authentication">
<title>Security and Authentication</title>
<para>
<itemizedlist>
@@ -316,7 +316,7 @@
</itemizedlist>
</para>
</section>
- <section id="sect-Wayland-Protocol-Creating-Objects">
+ <section id="sect-Protocol-Creating-Objects">
<title>Creating Objects</title>
<para>
<itemizedlist>
@@ -334,7 +334,7 @@
</itemizedlist>
</para>
</section>
- <section id="sect-Wayland-Protocol-Compositor">
+ <section id="sect-Protocol-Compositor">
<title>Compositor</title>
<para>
The compositor is a global object, advertised at connect time.
@@ -344,20 +344,20 @@
protocol description.
</para>
</section>
- <section id="sect-Wayland-Protocol-Surface">
+ <section id="sect-Protocol-Surface">
<title>Surface</title>
<para>
Created by the client.
</para>
<para>
- See <xref linkend="protocol-interface-wl_surface"/> for the protocol
+ See <xref linkend="protocol-spec-interface-wl_surface"/> for the protocol
description.
</para>
<para>
Needs a way to set input region, opaque region.
</para>
</section>
- <section id="sect-Wayland-Protocol-Input">
+ <section id="sect-Protocol-Input">
<title>Input</title>
<para>
Represents a group of input devices, including mice, keyboards. Has a
@@ -365,7 +365,7 @@
delivered in both screen coordinates and surface local coordinates.
</para>
<para>
- See <xref linkend="protocol-interface-wl_input_device"/> for the
+ See <xref linkend="protocol-spec-interface-wl_input_device"/> for the
protocol description.
</para>
<para>
@@ -417,14 +417,14 @@
image, the image will flicker. Broken app, I suppose.
</para>
</section>
- <section id="sect-Wayland-Protocol-Output">
+ <section id="sect-Protocol-Output">
<title>Output</title>
<para>
A output is a global object, advertised at connect time or as they
come and go.
</para>
<para>
- See <xref linkend="protocol-interface-wl_output"/> for the protocol
+ See <xref linkend="protocol-spec-interface-wl_output"/> for the protocol
description.
</para>
<para>
@@ -453,7 +453,7 @@
</listitem>
</itemizedlist>
</section>
- <section id="sect-Wayland-Protocol-Shared-Object-Cache">
+ <section id="sect-Protocol-Shared-Object-Cache">
<title>Shared Object Cache</title>
<para>
Cache for sharing glyphs, icons, cursors across clients. Lets clients
@@ -508,7 +508,7 @@
</itemizedlist>
</para>
</section>
- <section id="sect-Wayland-Protocol-Drag-and-Drop">
+ <section id="sect-Protocol-Drag-and-Drop">
<title>Drag and Drop</title>
<para>
Multi-device aware. Orthogonal to rest of wayland, as it is its own
@@ -517,9 +517,9 @@
expose mode, for example).
</para>
<para>
- See <xref linkend="protocol-interface-wl_data_offer"/>,
- <xref linkend="protocol-interface-wl_data_source"/> and
- <xref linkend="protocol-interface-wl_data_offer"/> for
+ See <xref linkend="protocol-spec-interface-wl_data_offer"/>,
+ <xref linkend="protocol-spec-interface-wl_data_source"/> and
+ <xref linkend="protocol-spec-interface-wl_data_offer"/> for
protocol descriptions.
</para>
<para>
diff --git a/doc/Wayland/en_US/Wayland.xml b/doc/Wayland/en_US/Wayland.xml
index 12766ff..c610bcc 100644
--- a/doc/Wayland/en_US/Wayland.xml
+++ b/doc/Wayland/en_US/Wayland.xml
@@ -7,9 +7,9 @@
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Architecture.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="WaylandProtocol.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="Protocol.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" />
<index />
</book>
diff --git a/doc/Wayland/protocol-to-docbook.xsl b/doc/Wayland/protocol-to-docbook.xsl
index e50d80d..be7cba3 100644
--- a/doc/Wayland/protocol-to-docbook.xsl
+++ b/doc/Wayland/protocol-to-docbook.xsl
@@ -32,7 +32,7 @@
<!-- Interface descriptions -->
<xsl:template match="interface" >
<section>
- <xsl:attribute name="id">protocol-<xsl:value-of select="name()"/>-<xsl:value-of select="@name" />
+ <xsl:attribute name="id">protocol-spec-<xsl:value-of select="name()"/>-<xsl:value-of select="@name" />
</xsl:attribute>
<title>
<xsl:value-of select="@name" />
@@ -86,7 +86,7 @@
<!-- Request/event list -->
<xsl:template match="request|event|enum">
<section>
- <xsl:attribute name="id">protocol-interface-<xsl:value-of select="../@name"/>-<xsl:value-of select="name()"/>-<xsl:value-of select="@name"/></xsl:attribute>
+ <xsl:attribute name="id">protocol-spec-interface-<xsl:value-of select="../@name"/>-<xsl:value-of select="name()"/>-<xsl:value-of select="@name"/></xsl:attribute>
<title>
<xsl:value-of select="../@name"/>::<xsl:value-of select="@name" />
<xsl:if test="description/@summary">