g_date_time_format: add standards notes to the doc
authorRyan Lortie <desrt@desrt.ca>
Sat, 3 Sep 2011 01:12:16 +0000 (21:12 -0400)
committerRyan Lortie <desrt@desrt.ca>
Sat, 3 Sep 2011 01:17:50 +0000 (21:17 -0400)
Explicitly mention C99's strftime() in the documentation for
g_date_time_format() as the one that we aim for compatibility with.
Specifically list the formats we do not support as well as the extra
ones that we borrow from glibc.

glib/gdatetime.c

index 4a20310..a89cf39 100644 (file)
@@ -2123,10 +2123,15 @@ get_numeric_format (gchar    *fmt,
  * Creates a newly allocated string representing the requested @format.
  *
  * The format strings understood by this function are a subset of the
- * strftime() format language. In contrast to strftime(), this function
- * always produces a UTF-8 string, regardless of the current locale.
- * Note that the rendering of many formats is locale-dependent and may
- * not match the strftime() output exactly.
+ * strftime() format language as specified by C99.  The %%D, %%U and %%W
+ * conversions are not supported, nor is the 'E' modifier.  The GNU
+ * extensions %%k, %%l, %%s and %%P are supported, however, as are the
+ * '0', '_' and '-' modifiers.
+ *
+ * In contrast to strftime(), this function always produces a UTF-8
+ * string, regardless of the current locale.  Note that the rendering of
+ * many formats is locale-dependent and may not match the strftime()
+ * output exactly.
  *
  * The following format specifiers are supported:
  *