GNOME Bugzilla – Bug 682794
Add usage guidance to logging documentation
Last modified: 2016-08-07 07:11:14 UTC
It would be useful if the “Message Logging” documentation included guidance on how programs and libraries should implement their logging. For example, should all libraries standardise on using G_MESSAGES_DEBUG, or would it be preferable for them to each have their own environment variable? If libraries are to have their own environment variables, what’s the recommended way for them to reimplement g_log_default_handler()? Just copy and paste it (plus all of its string escaping code)? What’s the recommended naming scheme for debug environment variables? What’s the recommended naming scheme for logging domains?
Created attachment 332684 [details] [review] gmessages: Expand documentation on log domains and G_MESSAGES_DEBUG Give some example log domains, and recommend that G_MESSAGES_DEBUG is used universally as the way to enable debug output (rather than having a separate environment variable per library).
Review of attachment 332684 [details] [review]: useful, thanks
Attachment 332684 [details] pushed as 371078b - gmessages: Expand documentation on log domains and G_MESSAGES_DEBUG