luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-12 23:46:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Clarify relationship between goffset and POSIX off_t

Browse Source 
The important thing here is that we can't arbitrarily mix these, even if
they will often have the same in-memory representation.

Helps: https://gitlab.gnome.org/GNOME/glib/-/issues/1484
Signed-off-by: Simon McVittie <smcv@collabora.com>
This commit is contained in:
Simon McVittie 2022-10-21 15:54:22 +01:00
parent 9635fd4e40
commit 6a8f96510b
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
glib/docs.c
View File

@ -775,13 +775,18 @@
* A signed integer type that is used for file offsets, * A signed integer type that is used for file offsets,
* corresponding to the POSIX type `off_t` as if compiling with * corresponding to the POSIX type `off_t` as if compiling with
* `_FILE_OFFSET_BITS` set to 64. #goffset is always 64 bits wide, even on * `_FILE_OFFSET_BITS` set to 64. #goffset is always 64 bits wide, even on
* 32-bit architectures. * 32-bit architectures, and even if `off_t` is only 32 bits.
* Values of this type can range from %G_MINOFFSET to * Values of this type can range from %G_MINOFFSET to
* %G_MAXOFFSET. * %G_MAXOFFSET.
* *
* To print or scan values of this type, use * To print or scan values of this type, use
* %G_GOFFSET_MODIFIER and/or %G_GOFFSET_FORMAT. * %G_GOFFSET_MODIFIER and/or %G_GOFFSET_FORMAT.
* *
* On platforms with more than one 64-bit standard integer type,
* even if `off_t` is also 64 bits in size, `goffset` and `off_t` are not
* necessarily implemented by the same 64-bit integer type.
* See #gsize for more details of what this implies.
*
* Since: 2.14 * Since: 2.14
*/ */
@ -804,6 +809,9 @@
* for scanning and printing values of type #goffset. It is a string * for scanning and printing values of type #goffset. It is a string
* literal. See also %G_GINT64_MODIFIER. * literal. See also %G_GINT64_MODIFIER.
* *
* This modifier should only be used with #goffset values, and not
* with `off_t`, which is not necessarily the same type or even the same size.
*
* Since: 2.20 * Since: 2.20
*/ */
@ -813,6 +821,9 @@
* This is the platform dependent conversion specifier for scanning * This is the platform dependent conversion specifier for scanning
* and printing values of type #goffset. See also %G_GINT64_FORMAT. * and printing values of type #goffset. See also %G_GINT64_FORMAT.
* *
* This format should only be used with #goffset values, and not
* with `off_t`, which is not necessarily the same type or even the same size.
*
* Since: 2.20 * Since: 2.20
*/ */