Attachment 47897 Details for Bug 38252 – [PATCH 2/8] Split Basic and Container types into subsections, promote "Type Signatures" to be an intro

[patch] [PATCH 2/8] Split Basic and Container types into subsections, promote "Type Signatures" to be an intro

0002-Split-Basic-and-Container-types-into-subsections-pro.patch (text/plain), 2.97 KB, created by Simon McVittie on 2011-06-13 07:41:48 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Simon McVittie

Created: 2011-06-13 07:41:48 UTC

Size: 2.97 KB

patch

obsolete

>From 8d3793e33352fe573e05c3a12e33313c515e8d1f Mon Sep 17 00:00:00 2001
>From: Simon McVittie <simon.mcvittie@collabora.co.uk>
>Date: Wed, 25 May 2011 18:03:01 +0100
>Subject: [PATCH 2/8] Split Basic and Container types into subsections,
> promote "Type Signatures" to be an intro
>
>The "Type Signatures" subsection is basically an introduction to the
>type system, so it doesn't need a heading of its own.
>---
> doc/dbus-specification.xml |   33 ++++++++++++++++++++++-----------
> 1 files changed, 22 insertions(+), 11 deletions(-)
>
>diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
>index 54f9049..65a6686 100644
>--- a/doc/dbus-specification.xml
>+++ b/doc/dbus-specification.xml
>@@ -276,18 +276,18 @@
>       it back from the wire format is <firstterm>unmarshaling</firstterm>.
>     </para>
> 
>-    <sect2 id="message-protocol-signatures">
>-      <title>Type Signatures</title>
>+    <para>
>+      The D-Bus protocol does not include type tags in the marshaled data; a
>+      block of marshaled values must have a known <firstterm>type
>+      signature</firstterm>.  The type signature is made up of <firstterm>type
>+      codes</firstterm>. A type code is an ASCII character representing the
>+      type of a value. Because ASCII characters are used, the type signature
>+      will always form a valid ASCII string. A simple string compare
>+      determines whether two type signatures are equivalent.
>+    </para>
> 
>-      <para>
>-        The D-Bus protocol does not include type tags in the marshaled data; a
>-        block of marshaled values must have a known <firstterm>type
>-        signature</firstterm>.  The type signature is made up of <firstterm>type
>-        codes</firstterm>. A type code is an ASCII character representing the
>-        type of a value. Because ASCII characters are used, the type signature
>-        will always form a valid ASCII string. A simple string compare 
>-        determines whether two type signatures are equivalent.
>-      </para>
>+    <sect2 id="basic-types">
>+      <title>Basic types</title>
> 
>       <para>
>         As a simple example, the type code for 32-bit integer (<literal>INT32</literal>) is
>@@ -307,6 +307,13 @@
>         <literal>INT32</literal> in this example. To marshal and unmarshal 
>         basic types, you simply read one value from the data
>         block corresponding to each type code in the signature.
>+      </para>
>+    </sect2>
>+
>+    <sect2 id="container-types">
>+      <title>Container types</title>
>+
>+      <para>
>         In addition to basic types, there are four <firstterm>container</firstterm> 
>         types: <literal>STRUCT</literal>, <literal>ARRAY</literal>, <literal>VARIANT</literal>, 
>         and <literal>DICT_ENTRY</literal>.
>@@ -419,6 +426,10 @@
>         In most languages, an array of dict entry would be represented as a 
>         map, hash table, or dict object.
>       </para>
>+    </sect2>
>+
>+    <sect2>
>+      <title>Summary of types</title>
> 
>       <para>
>         The following table summarizes the D-Bus types.
>-- 
>1.7.5.4
>

Actions: View | Splinter Review

Attachments on bug 38252: 47896 | 47897 | 47898 | 47899 | 47900 | 47901 | 47902 | 47903

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.