Changes between Version 1 and Version 2 of Logging

Timestamp:

Apr 15, 2013, 8:24:44 PM (11 years ago)

Author:

leper

Comment:

Clarify that debug_printf breaks into the debugger.

Logging

@@ -3 +3 @@
 = Engine =
 
-The engine is written in C++. Prefer these functions for logging and outputting text:
+The [wiki:Coding_Conventions#Errorreporting coding conventions] have some information regarding logging in the engine.
 
- * `debug_printf(const wchar_t* format, ...)`
+The engine is written in C++. Prefer the following functions for logging and outputting text:
+
  * `LOGMESSAGE(const wchar_t* format, ...)`
  * `LOGMESSAGERENDER(const wchar_t* format, ...)`
+
+Use these functions to report possible misconfigurations or errors that can be caused by modding:
+
  * `LOGWARNING(const wchar_t* format, ...)`
  * `LOGERROR(const wchar_t* format, ...)`
 
+Use `debug_printf` to indicate engine bugs, as this breaks into a debugger.
+
+ * `debug_printf(const wchar_t* format, ...)`
+
 ||= '''Function''' =||= '''Game console''' =||= '''Rendered message''' =||= '''Main log''' =||= '''Interesting log''' =||= '''std::out'''* =||= '''std::err''' =||
-||`debug_printf` ||  N  ||  N  ||  N  ||  N  ||  Y  ||  N  ||
 ||`LOGMESSAGE` ||  N  ||  N  ||  Y  ||  N  ||  N  ||  N  ||
 ||`LOGMESSAGERENDER` ||  Y  ||  Y - green text  ||  Y  ||  N  ||  N  ||  N  ||
 ||`LOGWARNING` ||  Y  ||  Y - yellow text  ||  Y  ||  Y  ||  Y  ||  N  ||
 ||`LOGERROR` ||  Y  ||  Y - red text  ||  Y  ||  Y  ||  Y  ||  N  ||
+||`debug_printf` ||  N  ||  N  ||  N  ||  N  ||  Y  ||  N  ||
  `*` On Windows, the game writes debug output instead of std::out. Run the game in a debugger or use [http://technet.microsoft.com/en-us/sysinternals/bb896647.aspx DebugView] to view it.[[BR]]