Changeset 90711 in vbox

Timestamp:

Aug 17, 2021 8:26:02 PM (3 years ago)

Author:

vboxsync

Message:

VBoxTray: Explain the 'release' log stuff for DEBUG builds when it isn't a release log at all.

File:

• trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxTray.cpp (modified) (5 diffs)

trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxTray.cpp

@@ -48 +48 @@
 #include <iprt/time.h>
 
-#ifdef DEBUG
-# define LOG_ENABLED
-# define LOG_GROUP LOG_GROUP_DEFAULT
-#endif
 #include <VBox/log.h>
-
 #include <VBox/err.h>
 
@@ -146 +141 @@
 uint32_t              g_fGuestDisplaysChanged = 0;
 
-static PRTLOGGER      g_pLoggerRelease = NULL;
-static uint32_t       g_cHistory = 10;                   /* Enable log rotation, 10 files. */
-static uint32_t       g_uHistoryFileTime = RT_SEC_1DAY;  /* Max 1 day per file. */
-static uint64_t       g_uHistoryFileSize = 100 * _1M;    /* Max 100MB per file. */
+static PRTLOGGER      g_pLoggerRelease = NULL;           /**< This is actually the debug logger in DEBUG builds! */
+static uint32_t       g_cHistory = 10;                   /**< Enable log rotation, 10 files. */
+static uint32_t       g_uHistoryFileTime = RT_SEC_1DAY;  /**< Max 1 day per file. */
+static uint64_t       g_uHistoryFileSize = 100 * _1M;    /**< Max 100MB per file. */
 
 #ifdef DEBUG_andy
@@ -570 +565 @@
 static int vboxTrayLogCreate(void)
 {
-    /* Create release logger (stdout + file). */
+    /* Create release (or debug) logger (stdout + file). */
     static const char * const s_apszGroups[] = VBOX_LOGGROUP_NAMES;
-    RTUINT fFlags = RTLOGFLAGS_PREFIX_THREAD | RTLOGFLAGS_PREFIX_TIME_PROG;
-#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
-    fFlags |= RTLOGFLAGS_USECRLF;
-#endif
     RTERRINFOSTATIC ErrInfo;
-    int rc = RTLogCreateEx(&g_pLoggerRelease, fFlags,
-#ifdef DEBUG
+    int rc = RTLogCreateEx(&g_pLoggerRelease, RTLOGFLAGS_PREFIX_THREAD | RTLOGFLAGS_PREFIX_TIME_PROG | RTLOGFLAGS_USECRLF,
+#ifdef DEBUG /* See below, debug logger not release. */
                            "all.e.l.f",
                            "VBOXTRAY_LOG",
@@ -591 +582 @@
     {
 #ifdef DEBUG
+        /* Register this logger as the _debug_ logger.
+           Note! This means any Log() statement preceeding this may cause a
+                 20yy-*VBoxTray*.log file to have been created and it will stay
+                 open till the process quits as we don't destroy it when
+                 replacing it here. */
         RTLogSetDefaultInstance(g_pLoggerRelease);
 #else
@@ -607 +603 @@
 static void vboxTrayLogDestroy(void)
 {
+    /* Only want to destroy the release logger before calling exit(). The debug
+       logger can be useful after that point... */
     RTLogDestroy(RTLogRelSetDefaultInstance(NULL));
 }