Add docs for #307047, Bryan Silverthorn.
authorMatthias Clasen <mclasen@redhat.com>
Tue, 19 Jul 2005 18:36:39 +0000 (18:36 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Tue, 19 Jul 2005 18:36:39 +0000 (18:36 +0000)
2005-07-19  Matthias Clasen  <mclasen@redhat.com>

        * glib/tmpl/byte_order.sgml: Add docs for #307047,
        Bryan Silverthorn.

docs/reference/ChangeLog
docs/reference/glib/tmpl/byte_order.sgml

index c90ec1b..1f426de 100644 (file)
@@ -1,3 +1,8 @@
+2005-07-19  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/tmpl/byte_order.sgml: Add docs for #307047,
+       Bryan Silverthorn.
+
 2005-07-15  Matthias Clasen  <mclasen@redhat.com>
 
        * === Released 2.7.3 ===
index 3006a48..e146a65 100644 (file)
@@ -7,7 +7,7 @@ a portable way to convert between different byte orders.
 <!-- ##### SECTION Long_Description ##### -->
 <para>
 These macros provide a portable way to determine the host byte order
-and to convert values between different byte orders.
+and to convert values between different byte orders. 
 </para>
 <para>
 The byte order is the order in which bytes are stored to create larger
@@ -38,6 +38,11 @@ which has been agreed on for use when communicating between different
 processors. The Internet uses what is known as 'network byte order'
 as the standard byte order (which is in fact the big-endian byte order).
 </para>
+<para>
+Note that the byte order conversion macros may evaluate their arguments 
+multiple times, thus you should not use them with arguments which have
+side-effects.
+</para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>