luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-05-31 18:00:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

doc: point to iconv(3) and iconv(3posix) for more details about iconv

Browse Source 
The documentation in GLib of iconv is forgivably brief. Advanced users (e.g.
for streaming use, for which this API is recommended over the simpler GLib
APIs) will want to know more detail about what happens when there’s an
error: without knowing, you can’t really use this function for streaming.

Point to both iconv(3posix), which gives the fully-portable details, i.e.
all that a user of GLib can rely on, and iconv(3), which is rather easier to
read, and may be of interest to those writing GNU-specific code, or who know
that their GLib is built with libiconv.

The API already promises that it’s the “[s]ame as the standard UNIX routine
iconv()”, so it’s quite safe to point to the relevant man pages; looking at
the source code bears this out, as g_iconv merely calls iconv.
This commit is contained in:
Reuben Thomas 2025-02-25 00:56:07 +00:00 committed by Philip Withnall
parent 7436b8056d
commit 5fc4248b74
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
glib/gconvert.c
View File

@ -172,6 +172,9 @@ g_iconv_open (const gchar *to_codeset,
* used), or it may return -1 and set an error such as %EILSEQ, in such a
* situation.
*
* See [`iconv(3posix)`](man:iconv(3posix)) and [`iconv(3)`](man:iconv(3)) for more details about behavior when an
* error occurs.
*
* Returns: count of non-reversible conversions, or -1 on error
**/
gsize