doc: Label Client/Server library as Appendex B.

Submitted by Bryce Harrington on Dec. 9, 2014, 2:26 a.m.

Details

Message ID 1418091971-28993-1-git-send-email-bryce@osg.samsung.com
State Superseded
Headers show

Not browsing as part of any series.

Commit Message

Bryce Harrington Dec. 9, 2014, 2:26 a.m.
The table of contents is out of order:

  ..
  Chapter 4.  Wayland Protocol and Model of Operation
  Appendix A. Wayland Protocol Specification
  Chapter 5.  Wayland Library

The protocol specification docs and the wayland library docs both are
generated documentation from source code as opposed to the prose text of
chapters 1-4, thus my guess is that both were intended to be Appendices.

Signed-off-by: Bryce Harrington <bryce@osg.samsung.com>
---
 doc/publican/sources/Library.xml | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Patch hide | download patch | download mbox

diff --git a/doc/publican/sources/Library.xml b/doc/publican/sources/Library.xml
index bc8c89e..27ad186 100644
--- a/doc/publican/sources/Library.xml
+++ b/doc/publican/sources/Library.xml
@@ -3,7 +3,7 @@ 
 <!ENTITY % BOOK_ENTITIES SYSTEM "Wayland.ent">
 %BOOK_ENTITIES;
 ]>
-<chapter id="chap-Library">
+<appendix id="appe-Library">
   <title>Wayland Library</title>
 
   <para>
@@ -16,7 +16,7 @@ 
   </para>
 
   <para>
-  This Chapter describes in detail each library's methods and their helpers,
+  This Appendix 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"/>.
@@ -24,4 +24,4 @@ 
 
   <xi:include href="WaylandClientAPI.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
   <xi:include href="WaylandServerAPI.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</chapter>
+</appendix>

Comments

I made the same change in the patches I submitted, and also split the 
client and server into different Appendicies.

On 12/08/2014 06:26 PM, Bryce Harrington wrote:
> The table of contents is out of order:
>
>    ..
>    Chapter 4.  Wayland Protocol and Model of Operation
>    Appendix A. Wayland Protocol Specification
>    Chapter 5.  Wayland Library
>
> The protocol specification docs and the wayland library docs both are
> generated documentation from source code as opposed to the prose text of
> chapters 1-4, thus my guess is that both were intended to be Appendices.
>
> Signed-off-by: Bryce Harrington <bryce@osg.samsung.com>
> ---
>   doc/publican/sources/Library.xml | 6 +++---
>   1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/doc/publican/sources/Library.xml b/doc/publican/sources/Library.xml
> index bc8c89e..27ad186 100644
> --- a/doc/publican/sources/Library.xml
> +++ b/doc/publican/sources/Library.xml
> @@ -3,7 +3,7 @@
>   <!ENTITY % BOOK_ENTITIES SYSTEM "Wayland.ent">
>   %BOOK_ENTITIES;
>   ]>
> -<chapter id="chap-Library">
> +<appendix id="appe-Library">
>     <title>Wayland Library</title>
>
>     <para>
> @@ -16,7 +16,7 @@
>     </para>
>
>     <para>
> -  This Chapter describes in detail each library's methods and their helpers,
> +  This Appendix 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"/>.
> @@ -24,4 +24,4 @@
>
>     <xi:include href="WaylandClientAPI.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
>     <xi:include href="WaylandServerAPI.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
> -</chapter>
> +</appendix>
>
On Mon, Dec 08, 2014 at 06:43:14PM -0800, Bill Spitzak wrote:
> I made the same change in the patches I submitted, and also split
> the client and server into different Appendicies.

Ah, sorry, didn't see that.
 
> On 12/08/2014 06:26 PM, Bryce Harrington wrote:
> >The table of contents is out of order:
> >
> >   ..
> >   Chapter 4.  Wayland Protocol and Model of Operation
> >   Appendix A. Wayland Protocol Specification
> >   Chapter 5.  Wayland Library
> >
> >The protocol specification docs and the wayland library docs both are
> >generated documentation from source code as opposed to the prose text of
> >chapters 1-4, thus my guess is that both were intended to be Appendices.
> >
> >Signed-off-by: Bryce Harrington <bryce@osg.samsung.com>
> >---
> >  doc/publican/sources/Library.xml | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> >
> >diff --git a/doc/publican/sources/Library.xml b/doc/publican/sources/Library.xml
> >index bc8c89e..27ad186 100644
> >--- a/doc/publican/sources/Library.xml
> >+++ b/doc/publican/sources/Library.xml
> >@@ -3,7 +3,7 @@
> >  <!ENTITY % BOOK_ENTITIES SYSTEM "Wayland.ent">
> >  %BOOK_ENTITIES;
> >  ]>
> >-<chapter id="chap-Library">
> >+<appendix id="appe-Library">
> >    <title>Wayland Library</title>
> >
> >    <para>
> >@@ -16,7 +16,7 @@
> >    </para>
> >
> >    <para>
> >-  This Chapter describes in detail each library's methods and their helpers,
> >+  This Appendix 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"/>.
> >@@ -24,4 +24,4 @@
> >
> >    <xi:include href="WaylandClientAPI.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
> >    <xi:include href="WaylandServerAPI.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
> >-</chapter>
> >+</appendix>
> >
> _______________________________________________
> wayland-devel mailing list
> wayland-devel@lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel
On Mon, Dec 08, 2014 at 06:26:11PM -0800, Bryce Harrington wrote:
> The table of contents is out of order:
> 
>   ..
>   Chapter 4.  Wayland Protocol and Model of Operation
>   Appendix A. Wayland Protocol Specification
>   Chapter 5.  Wayland Library
> 
> The protocol specification docs and the wayland library docs both are
> generated documentation from source code as opposed to the prose text of
> chapters 1-4, thus my guess is that both were intended to be Appendices.
> 
> Signed-off-by: Bryce Harrington <bryce@osg.samsung.com>

Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>

Cheers,
   Peter

> ---
>  doc/publican/sources/Library.xml | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/publican/sources/Library.xml b/doc/publican/sources/Library.xml
> index bc8c89e..27ad186 100644
> --- a/doc/publican/sources/Library.xml
> +++ b/doc/publican/sources/Library.xml
> @@ -3,7 +3,7 @@
>  <!ENTITY % BOOK_ENTITIES SYSTEM "Wayland.ent">
>  %BOOK_ENTITIES;
>  ]>
> -<chapter id="chap-Library">
> +<appendix id="appe-Library">
>    <title>Wayland Library</title>
>  
>    <para>
> @@ -16,7 +16,7 @@
>    </para>
>  
>    <para>
> -  This Chapter describes in detail each library's methods and their helpers,
> +  This Appendix 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"/>.
> @@ -24,4 +24,4 @@
>  
>    <xi:include href="WaylandClientAPI.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
>    <xi:include href="WaylandServerAPI.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
> -</chapter>
> +</appendix>
> -- 
> 1.9.1
> 
> _______________________________________________
> wayland-devel mailing list
> wayland-devel@lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel
>