gconvert: add note to avoid transliteration
authorRyan Lortie <desrt@desrt.ca>
Thu, 20 Feb 2014 23:49:37 +0000 (18:49 -0500)
committerRyan Lortie <desrt@desrt.ca>
Thu, 20 Feb 2014 23:52:33 +0000 (18:52 -0500)
Add a note to the documentation of g_convert() advising to avoid using
it for transliteration.  Link to g_str_to_ascii().

glib/gconvert.c

index 8831bd6..2be1cbb 100644 (file)
@@ -526,6 +526,9 @@ g_convert_with_iconv (const gchar *str,
  * character until it knows that the next character is not a mark that
  * could combine with the base character.)
  *
+ * Using extensions such as "//TRANSLIT" may not work (or may not work
+ * well) on many platforms.  Consider using g_str_to_ascii() instead.
+ *
  * Returns: If the conversion was successful, a newly allocated
  *               nul-terminated string, which must be freed with
  *               g_free(). Otherwise %NULL and @error will be set.