luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-10 03:16:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'ebassi/collate-docs' into 'main'

Browse Source 
Collation keys are not encoded in UTF-8

See merge request GNOME/glib!4260
This commit is contained in:
Philip Withnall 2024-09-09 19:30:39 +00:00
commit c09ffca226
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
glib/gunicollate.c
View File

@ -372,11 +372,16 @@ carbon_collate_key_for_filename (const gchar *str,
* The results of comparing the collation keys of two strings * The results of comparing the collation keys of two strings
* with strcmp() will always be the same as comparing the two * with strcmp() will always be the same as comparing the two
* original keys with g_utf8_collate(). * original keys with g_utf8_collate().
* *
* Note that this function depends on the [current locale][setlocale]. * Note that this function depends on the [current locale][setlocale].
*
* Note that the returned string is not guaranteed to be in any
* encoding, especially UTF-8. The returned value is meant to be
* used only for comparisons.
* *
* Returns: a newly allocated string. This string should * Returns: (transfer full) (type filename): a newly allocated string.
* be freed with g_free() when you are done with it. * The contents of the string are only meant to be used when sorting.
* This string should be freed with g_free() when you are done with it.
**/ **/
gchar * gchar *
g_utf8_collate_key (const gchar *str, g_utf8_collate_key (const gchar *str,
@ -504,8 +509,13 @@ g_utf8_collate_key (const gchar *str,
* *
* Note that this function depends on the [current locale][setlocale]. * Note that this function depends on the [current locale][setlocale].
* *
* Returns: a newly allocated string. This string should * Note that the returned string is not guaranteed to be in any
* be freed with g_free() when you are done with it. * encoding, especially UTF-8. The returned value is meant to be
* used only for comparisons.
*
* Returns: (transfer full) (type filename): a newly allocated string.
* The contents of the string are only meant to be used when sorting.
* This string should be freed with g_free() when you are done with it.
* *
* Since: 2.8 * Since: 2.8
*/ */