summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRico Tzschichholz <ricotz@ubuntu.com>2016-07-21 10:57:36 +0200
committerRico Tzschichholz <ricotz@ubuntu.com>2016-07-21 10:57:36 +0200
commit823c28e096c6928aeaafe050a0eba0c4d5edca0c (patch)
tree3b57bdf95d3b211e835dbe74034730da5a3a50a4
parentb260940f66877a511f728bc192ec644ce84bf4ad (diff)
downloadgobject-introspection-823c28e096c6928aeaafe050a0eba0c4d5edca0c.tar.gz
gir: Update annotations from GLib git master
-rw-r--r--gir/glib-2.0.c48
1 files changed, 25 insertions, 23 deletions
diff --git a/gir/glib-2.0.c b/gir/glib-2.0.c
index 0ae171b1..cb1bb41e 100644
--- a/gir/glib-2.0.c
+++ b/gir/glib-2.0.c
@@ -19417,13 +19417,12 @@
* @log_domain: log domain, usually %G_LOG_DOMAIN
* @log_level: log level, either from #GLogLevelFlags, or a user-defined
* level
- * @format: message format, in printf() style
- * @...: parameters to insert into the format string, followed by key–value
- * pairs of structured data to add to the log message, terminated with a
- * %NULL
+ * @...: key-value pairs of structured data to add to the log entry, followed
+ * by the key "MESSAGE", followed by a printf()-style message format,
+ * followed by parameters to insert in the format string
*
- * Log a message with structured data. The message will be passed through to the
- * log writer set by the application using g_log_set_writer_func(). If the
+ * Log a message with structured data. The message will be passed through to
+ * the log writer set by the application using g_log_set_writer_func(). If the
* message is fatal (i.e. its log level is %G_LOG_LEVEL_ERROR), the program will
* be aborted at the end of this function.
*
@@ -19438,8 +19437,12 @@
* `GLIB_` prefix.
*
* The @log_domain will be converted into a `GLIB_DOMAIN` field. @log_level will
- * be converted into a `PRIORITY` field. @format will have its placeholders
- * substituted for the provided values and be converted into a `MESSAGE` field.
+ * be converted into a
+ * [`PRIORITY`](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html#PRIORITY=)
+ * field. The format string will have its placeholders substituted for the provided
+ * values and be converted into a
+ * [`MESSAGE`](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html#MESSAGE=)
+ * field.
*
* Other fields you may commonly want to pass into this function:
*
@@ -19450,21 +19453,20 @@
* * [`ERRNO`](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html#ERRNO=)
*
* Note that `CODE_FILE`, `CODE_LINE` and `CODE_FUNC` are automatically set by
- * the logging macros, g_debug_structured(), G_DEBUG_HERE(),
- * g_message_structured(), g_warning_structured(), g_critical_structured() and
- * g_error_structured().
+ * the logging macros, G_DEBUG_HERE(), g_message(), g_warning(), g_critical(),
+ * g_error(), etc, if the symbols `G_LOG_USE_STRUCTURED` is defined before including
+ * glib.h.
*
* For example:
- * ```
+ * |[<!-- language="C" -->
* g_log_structured (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,
- * "This is a debug message about pointer %p and integer %u.",
- * some_pointer, some_integer,
* "MESSAGE_ID", "06d4df59e6c24647bfe69d2c27ef0b4e",
* "MY_APPLICATION_CUSTOM_FIELD", "some debug string",
- * NULL);
- * ```
+ * "MESSAGE", "This is a debug message about pointer %p and integer %u.",
+ * some_pointer, some_integer);
+ * ]|
*
- * Note that each `MESSAGE_ID` **must** be [uniquely and randomly
+ * Note that each `MESSAGE_ID` must be [uniquely and randomly
* generated](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html#MESSAGE_ID=).
* If adding a `MESSAGE_ID`, consider shipping a [message
* catalog](https://www.freedesktop.org/wiki/Software/systemd/catalog/) with
@@ -19476,7 +19478,7 @@
* interpreted as a string.
*
* For example:
- * ```
+ * |[<!-- language="C" -->
* const GLogField fields[] = {
* { "MESSAGE", "This is a debug message.", -1 },
* { "MESSAGE_ID", "fcfb2e1e65c3494386b74878f1abf893", -1 },
@@ -19484,14 +19486,14 @@
* { "MY_APPLICATION_STATE", state_object, 0 },
* };
* g_log_structured_array (G_LOG_LEVEL_DEBUG, fields, G_N_ELEMENTS (fields));
- * ```
+ * ]|
*
- * Note also that, even if no structured fields are specified, the argument list
- * **must** be %NULL-terminated.
+ * Note also that, even if no structured fields are specified, the key-value
+ * part of the argument list must be %NULL-terminated.
*
* The default writer function for `stdout` and `stderr` will automatically
- * append a new-line character to the @format, so you should not add one
- * manually.
+ * append a new-line character after the message, so you should not add one
+ * manually to the format string.
*
* Since: 2.50
*/