fix docs; they said we validated the UTF-8, but we can't possibly detect

2001-05-14  Havoc Pennington  <hp@redhat.com>

	* gutf8.c (g_utf8_get_char): fix docs; they said we validated
	the UTF-8, but we can't possibly detect partial chars since
	there's no length arg here, so trying to use this function
	on invalid UTF-8 is a bad idea.

diff --git a/ChangeLog b/ChangeLog
index dd54851e7df2cb88aaa6586d837c95b9e91e2458..e7ace3b5c47577f0b89fa9355e4c12e31c6932a0 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2001-05-14  Havoc Pennington  <hp@redhat.com>
+
+       * gutf8.c (g_utf8_get_char): fix docs; they said we validated 
+       the UTF-8, but we can't possibly detect partial chars since
+       there's no length arg here, so trying to use this function 
+       on invalid UTF-8 is a bad idea.
+
 Thu May 10 23:21:30 2001  Owen Taylor  <otaylor@redhat.com>
 
        * gmessages.c (g_log_write_prefix): Avoid using stderr

diff --git a/ChangeLog.pre-2-0 b/ChangeLog.pre-2-0
index dd54851e7df2cb88aaa6586d837c95b9e91e2458..e7ace3b5c47577f0b89fa9355e4c12e31c6932a0 100644 (file)
--- a/ChangeLog.pre-2-0
+++ b/ChangeLog.pre-2-0
@@ -1,3 +1,10 @@
+2001-05-14  Havoc Pennington  <hp@redhat.com>
+
+       * gutf8.c (g_utf8_get_char): fix docs; they said we validated 
+       the UTF-8, but we can't possibly detect partial chars since
+       there's no length arg here, so trying to use this function 
+       on invalid UTF-8 is a bad idea.
+
 Thu May 10 23:21:30 2001  Owen Taylor  <otaylor@redhat.com>
 
        * gmessages.c (g_log_write_prefix): Avoid using stderr

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index dd54851e7df2cb88aaa6586d837c95b9e91e2458..e7ace3b5c47577f0b89fa9355e4c12e31c6932a0 100644 (file)
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,3 +1,10 @@
+2001-05-14  Havoc Pennington  <hp@redhat.com>
+
+       * gutf8.c (g_utf8_get_char): fix docs; they said we validated 
+       the UTF-8, but we can't possibly detect partial chars since
+       there's no length arg here, so trying to use this function 
+       on invalid UTF-8 is a bad idea.
+
 Thu May 10 23:21:30 2001  Owen Taylor  <otaylor@redhat.com>
 
        * gmessages.c (g_log_write_prefix): Avoid using stderr

diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12
index dd54851e7df2cb88aaa6586d837c95b9e91e2458..e7ace3b5c47577f0b89fa9355e4c12e31c6932a0 100644 (file)
--- a/ChangeLog.pre-2-12
+++ b/ChangeLog.pre-2-12
@@ -1,3 +1,10 @@
+2001-05-14  Havoc Pennington  <hp@redhat.com>
+
+       * gutf8.c (g_utf8_get_char): fix docs; they said we validated 
+       the UTF-8, but we can't possibly detect partial chars since
+       there's no length arg here, so trying to use this function 
+       on invalid UTF-8 is a bad idea.
+
 Thu May 10 23:21:30 2001  Owen Taylor  <otaylor@redhat.com>
 
        * gmessages.c (g_log_write_prefix): Avoid using stderr

diff --git a/ChangeLog.pre-2-2 b/ChangeLog.pre-2-2
index dd54851e7df2cb88aaa6586d837c95b9e91e2458..e7ace3b5c47577f0b89fa9355e4c12e31c6932a0 100644 (file)
--- a/ChangeLog.pre-2-2
+++ b/ChangeLog.pre-2-2
@@ -1,3 +1,10 @@
+2001-05-14  Havoc Pennington  <hp@redhat.com>
+
+       * gutf8.c (g_utf8_get_char): fix docs; they said we validated 
+       the UTF-8, but we can't possibly detect partial chars since
+       there's no length arg here, so trying to use this function 
+       on invalid UTF-8 is a bad idea.
+
 Thu May 10 23:21:30 2001  Owen Taylor  <otaylor@redhat.com>
 
        * gmessages.c (g_log_write_prefix): Avoid using stderr

diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4
index dd54851e7df2cb88aaa6586d837c95b9e91e2458..e7ace3b5c47577f0b89fa9355e4c12e31c6932a0 100644 (file)
--- a/ChangeLog.pre-2-4
+++ b/ChangeLog.pre-2-4
@@ -1,3 +1,10 @@
+2001-05-14  Havoc Pennington  <hp@redhat.com>
+
+       * gutf8.c (g_utf8_get_char): fix docs; they said we validated 
+       the UTF-8, but we can't possibly detect partial chars since
+       there's no length arg here, so trying to use this function 
+       on invalid UTF-8 is a bad idea.
+
 Thu May 10 23:21:30 2001  Owen Taylor  <otaylor@redhat.com>
 
        * gmessages.c (g_log_write_prefix): Avoid using stderr

diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6
index dd54851e7df2cb88aaa6586d837c95b9e91e2458..e7ace3b5c47577f0b89fa9355e4c12e31c6932a0 100644 (file)
--- a/ChangeLog.pre-2-6
+++ b/ChangeLog.pre-2-6
@@ -1,3 +1,10 @@
+2001-05-14  Havoc Pennington  <hp@redhat.com>
+
+       * gutf8.c (g_utf8_get_char): fix docs; they said we validated 
+       the UTF-8, but we can't possibly detect partial chars since
+       there's no length arg here, so trying to use this function 
+       on invalid UTF-8 is a bad idea.
+
 Thu May 10 23:21:30 2001  Owen Taylor  <otaylor@redhat.com>
 
        * gmessages.c (g_log_write_prefix): Avoid using stderr

diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index dd54851e7df2cb88aaa6586d837c95b9e91e2458..e7ace3b5c47577f0b89fa9355e4c12e31c6932a0 100644 (file)
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -1,3 +1,10 @@
+2001-05-14  Havoc Pennington  <hp@redhat.com>
+
+       * gutf8.c (g_utf8_get_char): fix docs; they said we validated 
+       the UTF-8, but we can't possibly detect partial chars since
+       there's no length arg here, so trying to use this function 
+       on invalid UTF-8 is a bad idea.
+
 Thu May 10 23:21:30 2001  Owen Taylor  <otaylor@redhat.com>
 
        * gmessages.c (g_log_write_prefix): Avoid using stderr

diff --git a/glib/gutf8.c b/glib/gutf8.c
index 541b1826eb114918c670561dcb83065098fb3803..a375316cc19886e52a644384fe3e2eec4d0e2be2 100644 (file)
--- a/glib/gutf8.c
+++ b/glib/gutf8.c
@@ -243,9 +243,10 @@ g_utf8_strlen (const gchar *p, gint max)
  * @p: a pointer to unicode character encoded as UTF-8
  * 
  * Convert a sequence of bytes encoded as UTF-8 to a unicode character.
+ * If @p does not point to a valid UTF-8 encoded character, results are
+ * undefined.
  * 
- * Return value: the resulting character or (gunichar)-1 if @p does
- *               not point to a valid UTF-8 encoded unicode character
+ * Return value: the resulting character
  **/
 gunichar
 g_utf8_get_char (const gchar *p)
@@ -492,7 +493,7 @@ g_unichar_to_utf8 (gunichar c, gchar *outbuf)
 /**
  * g_utf8_strchr:
  * @p: a nul-terminated utf-8 string
- * @c: a iso-10646 character/
+ * @c: a iso-10646 character
  * 
  * Find the leftmost occurence of the given iso-10646 character
  * in a UTF-8 string.
@@ -1387,7 +1388,7 @@ g_ucs4_to_utf16 (const gunichar  *str,
  * Validates UTF-8 encoded text. @str is the text to validate;
  * if @str is nul-terminated, then @max_len can be -1, otherwise
  * @max_len should be the number of bytes to validate.
- * If @end is non-NULL, then the end of the valid range
+ * If @end is non-%NULL, then the end of the valid range
  * will be stored there (i.e. the address of the first invalid byte
  * if some bytes were invalid, or the end of the text being validated
  * otherwise).

diff --git a/gutf8.c b/gutf8.c
index 541b1826eb114918c670561dcb83065098fb3803..a375316cc19886e52a644384fe3e2eec4d0e2be2 100644 (file)
--- a/gutf8.c
+++ b/gutf8.c
@@ -243,9 +243,10 @@ g_utf8_strlen (const gchar *p, gint max)
  * @p: a pointer to unicode character encoded as UTF-8
  * 
  * Convert a sequence of bytes encoded as UTF-8 to a unicode character.
+ * If @p does not point to a valid UTF-8 encoded character, results are
+ * undefined.
  * 
- * Return value: the resulting character or (gunichar)-1 if @p does
- *               not point to a valid UTF-8 encoded unicode character
+ * Return value: the resulting character
  **/
 gunichar
 g_utf8_get_char (const gchar *p)
@@ -492,7 +493,7 @@ g_unichar_to_utf8 (gunichar c, gchar *outbuf)
 /**
  * g_utf8_strchr:
  * @p: a nul-terminated utf-8 string
- * @c: a iso-10646 character/
+ * @c: a iso-10646 character
  * 
  * Find the leftmost occurence of the given iso-10646 character
  * in a UTF-8 string.
@@ -1387,7 +1388,7 @@ g_ucs4_to_utf16 (const gunichar  *str,
  * Validates UTF-8 encoded text. @str is the text to validate;
  * if @str is nul-terminated, then @max_len can be -1, otherwise
  * @max_len should be the number of bytes to validate.
- * If @end is non-NULL, then the end of the valid range
+ * If @end is non-%NULL, then the end of the valid range
  * will be stored there (i.e. the address of the first invalid byte
  * if some bytes were invalid, or the end of the text being validated
  * otherwise).