gmessages: Document namespacing recommendation for structured log fields

We recommend that all custom log fields are namespaced to avoid
collisions.

https://bugzilla.gnome.org/show_bug.cgi?id=744456
This commit is contained in:
Philip Withnall 2016-07-17 17:10:41 +01:00
parent 42725fb17d
commit 12acd90d8a

View File

@ -1311,7 +1311,9 @@ color_reset (gboolean use_color)
* structured data, use g_log_structured_array(). The keys for structured data
* should follow the [systemd journal
* fields](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html)
* specification.
* specification. It is suggested that custom keys are namespaced according to
* the code which sets them. For example, custom keys from GLib all have a
* `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