summaryrefslogtreecommitdiff
path: root/glib/docs.c
diff options
context:
space:
mode:
authorChristoph Reiter <reiter.christoph@gmail.com>2018-05-05 18:19:50 +0200
committerChristoph Reiter <creiter@src.gnome.org>2018-05-18 18:54:33 +0200
commita9164f55f7db1e620d336511ea5461207b7a06b6 (patch)
tree117bfc927aea03a5d3db7349c804fc5fc607a2ef /glib/docs.c
parent41e008266dfd489f6c7906af9414cb3ff5bb660f (diff)
downloadglib-a9164f55f7db1e620d336511ea5461207b7a06b6.tar.gz
docs: Add a note that the printf format macros might not be compatible with system printf()
The current docs implied, by using the printf name, that the macros would be compatible with printf(), but that's not always the case. On Windows we use gnulib if the system printf isn't good enough. This can happen on MinGW without __USE_MINGW_ANSI_STDIO set or with MSVC with a varrying degree of incompatibility. https://bugzilla.gnome.org/show_bug.cgi?id=795569
Diffstat (limited to 'glib/docs.c')
-rw-r--r--glib/docs.c6
1 files changed, 6 insertions, 0 deletions
diff --git a/glib/docs.c b/glib/docs.c
index a67bc3411..080c1b0de 100644
--- a/glib/docs.c
+++ b/glib/docs.c
@@ -50,6 +50,12 @@
* GLib also defines macros for the limits of some of the standard
* integer and floating point types, as well as macros for suitable
* printf() formats for these types.
+ *
+ * Note that depending on the platform and build configuration, the format
+ * macros might not be compatible with the system provided printf() function,
+ * because GLib might use a different printf() implementation internally.
+ * The format macros will always work with GLib API (like g_print()), and with
+ * any C99 compatible printf() implementation.
*/
/**