GNOME Bugzilla – Bug 769785
gmessages: Expand documentation further for structured logging
Last modified: 2016-08-12 12:16:46 UTC
I love documentation. Simple patches attached.
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.
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).
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
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
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