qtlogging: Document QT_MESSAGELOGCONTEXT define
Document it here to let people know about the pitfalls with some placeholder values. Link the QMessageLogContext class doc for more information. Pick-to: 6.2 Change-Id: I8e7b4c0dcb8bceeeee645664c98e63ae7ca7e854 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com> Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com>
This commit is contained in:
parent
146749f9b7
commit
f08704330d
@ -2021,13 +2021,17 @@ void qErrnoWarning(int code, const char *msg, ...)
|
||||
environment variable; if both \l qSetMessagePattern() is called and QT_MESSAGE_PATTERN is
|
||||
set, the environment variable takes precedence.
|
||||
|
||||
\note The information for the placeholders \c category, \c file, \c function and \c line is
|
||||
only recorded in debug builds. Alternatively, \c QT_MESSAGELOGCONTEXT can be defined
|
||||
explicitly. For more information refer to the QMessageLogContext documentation.
|
||||
|
||||
\note The message pattern only applies to unstructured logging, such as the default
|
||||
\c stderr output. Structured logging such as systemd will record the message as is,
|
||||
along with as much structured information as can be captured.
|
||||
|
||||
Custom message handlers can use qFormatLogMessage() to take \a pattern into account.
|
||||
|
||||
\sa qInstallMessageHandler(), {Debugging Techniques}, {QLoggingCategory}
|
||||
\sa qInstallMessageHandler(), {Debugging Techniques}, {QLoggingCategory}, QMessageLogContext
|
||||
*/
|
||||
|
||||
QtMessageHandler qInstallMessageHandler(QtMessageHandler h)
|
||||
|
Loading…
Reference in New Issue
Block a user