After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 769785 - gmessages: Expand documentation further for structured logging
gmessages: Expand documentation further for structured logging
Status: RESOLVED FIXED
Product: glib
Classification: Platform
Component: general
unspecified
Other All
: Normal normal
: ---
Assigned To: gtkdev
gtkdev
Depends on:
Blocks:
 
 
Reported: 2016-08-12 09:54 UTC by Philip Withnall
Modified: 2016-08-12 12:16 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
gmessages: Drop one of the documentation sections (1.29 KB, patch)
2016-08-12 09:54 UTC, Philip Withnall
committed Details | Review
gmessages: Add doc cross-refs about enabling structured logging (9.65 KB, patch)
2016-08-12 09:54 UTC, Philip Withnall
committed Details | Review

Description Philip Withnall 2016-08-12 09:54:42 UTC
I love documentation. Simple patches attached.
Comment 1 Philip Withnall 2016-08-12 09:54:51 UTC
Created attachment 333165 [details] [review]
gmessages: Drop one of the documentation sections

It was short, unhelpful, and easy to confuse with the longer and more
informative documentation sections.
Comment 2 Philip Withnall 2016-08-12 09:54:57 UTC
Created attachment 333166 [details] [review]
gmessages: Add doc cross-refs about enabling structured logging

Ensure that all the old log handler documentation includes
cross-references to a new section about how to enable structured logging
(tl;dr: #define G_LOG_USE_STRUCTURED).
Comment 3 Ignacio Casal Quinteiro (nacho) 2016-08-12 10:00:05 UTC
Review of attachment 333165 [details] [review]:

See the minor comment otherwise ok

::: glib/gmessages.c
@@ +29,2 @@
 /**
+ * SECTION:messages

this change should probably go as a different commit
Comment 4 Ignacio Casal Quinteiro (nacho) 2016-08-12 10:02:49 UTC
Review of attachment 333166 [details] [review]:

See the minor comment, feel free to push after fixing that.

::: glib/gmessages.c
@@ +56,3 @@
  * logged through the traditional g_log() API are ultimatively passed to
  * g_log_structured(), so that all log messages end up in same destination.
+ * If %G_LOG_USE_STRUCTURED is defined, g_test_expect_message() will become

will become will become
Comment 5 Philip Withnall 2016-08-12 12:16:34 UTC
Fixed the duplicate typo (oops); didn't split up the first commit as I don't think that makes sense. Thanks for the fast review!

Attachment 333165 [details] pushed as f7825f9 - gmessages: Drop one of the documentation sections
Attachment 333166 [details] pushed as a079de9 - gmessages: Add doc cross-refs about enabling structured logging