[glib/glib-2-30] In the GVariant intro, mention lack of built-in endianness, and rationale

[Simon McVittie <smcv src gnome org>]

commit 04da052c1e871018801ede724e699502b953045c
Author: Simon McVittie <simon mcvittie collabora co uk>
Date:   Mon Oct 3 14:27:15 2011 +0100

    In the GVariant intro, mention lack of built-in endianness, and rationale
    
    Presumably, the rationale for not storing the endianness is that
    GVariant is a recursive type system, and in a sane format, endianness
    only needs to be stored once per blob of data (once per D-Bus message,
    once per file on disk, etc.).
    
    Bug: https://bugzilla.gnome.org/show_bug.cgi?id=632049
    Signed-off-by: Simon McVittie <simon mcvittie collabora co uk>
    Reviewed-by: Ryan Lortie <desrt desrt ca>

 glib/gvariant.c |    8 ++++++++
 1 files changed, 8 insertions(+), 0 deletions(-)
---
diff --git a/glib/gvariant.c b/glib/gvariant.c
index 5e53619..5f49c8c 100644
--- a/glib/gvariant.c
+++ b/glib/gvariant.c
@@ -71,6 +71,14 @@
  * as the serialisation format of a D-Bus message body: use #GDBusMessage,
  * in the gio library, for those.)
  *
+ * For space-efficiency, the #GVariant serialisation format does not
+ * automatically include the variant's type or endianness, which must
+ * either be implied from context (such as knowledge that a particular
+ * file format always contains a little-endian %G_VARIANT_TYPE_VARIANT)
+ * or supplied out-of-band (for instance, a type and/or endianness
+ * indicator could be placed at the beginning of a file, network message
+ * or network stream).
+ *
  * For convenience to C programmers, #GVariant features powerful
  * varargs-based value construction and destruction.  This feature is
  * designed to be embedded in other libraries.