Add a footnote about surrogate pairs. (#317683, Behdad Esfahbod)

2005-10-26  Matthias Clasen  <mclasen@redhat.com>

	* glib/tmpl/unicode.sgml: Add a footnote about surrogate
	pairs.  (#317683, Behdad Esfahbod)

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index a0573853b9d9438832552d77f6e336e83fe6b677..7b91178461cc5a1684e421ecc7fb2e2d10602a34 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+2005-10-26  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/tmpl/unicode.sgml: Add a footnote about surrogate 
+       pairs.  (#317683, Behdad Esfahbod)
+
 2005-10-05  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/compiling.sgml: Document gmodule-no-export-2.0

diff --git a/docs/reference/glib/tmpl/unicode.sgml b/docs/reference/glib/tmpl/unicode.sgml
index 0ce4aed94642b7ff31eea11e1581e90fcc7e7a84..466299dc045e7a200bf36b2aa4abee0032a9bca8 100644 (file)
--- a/docs/reference/glib/tmpl/unicode.sgml
+++ b/docs/reference/glib/tmpl/unicode.sgml
@@ -40,7 +40,12 @@ A type which can hold any UCS-4 character code.
 
 <!-- ##### TYPEDEF gunichar2 ##### -->
 <para>
-A type which can hold any UTF-16 character code. 
+A type which can hold any UTF-16 code 
+point<footnote id="utf16_surrogate_pairs">UTF-16 also has so called 
+<firstterm>surrogate pairs</firstterm> to encode characters beyond the 
+BMP as pairs of 16bit numbers. Surrogate pairs cannot be stored in a 
+single gunichar2 field, but all GLib functions accepting gunichar2 arrays 
+will correctly interpret surrogate pairs.</footnote>.
 </para>