From: navarro <navarro@caraja.(none)>
Date: Fri, 23 Mar 2012 15:37:24 +0000 (+0100)
Subject: More explain for log
X-Git-Tag: v3_7~234
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/210ce20245561b17eb96f1155082c3d185282ef3

More explain for log
---

diff --git a/src/surf/surf_config.c b/src/surf/surf_config.c
index 72ec71f5af..f73f5016bd 100644
--- a/src/surf/surf_config.c
+++ b/src/surf/surf_config.c
@@ -19,11 +19,45 @@ xbt_cfg_t _surf_cfg_set = NULL;
 
 static void LOG_help(void)
 {
-  printf("Description of the logging output:\n");
-  printf("\tIn your command line use option: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n");
-  printf("\t\tCATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n");
-  printf("\t\tPRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n");
-  printf("\n");
+  printf("Description of the logging output:\n"
+"\n   Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
+"      CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
+"      PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
+"         -> trace: enter and return of some functions\n"
+"         -> debug: crufty output\n"
+"         -> verbose: verbose output for the user wanting more\n"
+"         -> info: output about the regular functionning\n"
+"         -> warning: minor issue encountered\n"
+"         -> error: issue encountered\n"
+"         -> critical: major issue encountered\n"
+"\n   Format configuration: --log=CATEGORY_NAME.fmt:OPTIONS\n"
+"     OPTIONS may be:\n"
+"         -> %%%%: the %% char\n"
+"         -> %%n: platform-dependent line separator (LOG4J compatible)\n"
+"         -> %%e: plain old space (SimGrid extension)\n"
+"\n"
+"         -> %%m: user-provided message\n"
+"\n"
+"         -> %%c: Category name (LOG4J compatible)\n"
+"         -> %%p: Priority name (LOG4J compatible)\n"
+"\n"
+"         -> %%h: Hostname (SimGrid extension)\n"
+"         -> %%P: Process name (SimGrid extension)\n"
+"         -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
+"         -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
+"\n"
+"         -> %%F: file name where the log event was raised (LOG4J compatible)\n"
+"         -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)\n"
+"         -> %%L: line number where the log event was raised (LOG4J compatible)\n"
+"         -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
+"                 Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n"
+"\n"
+"         -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the GNU libc because\n"
+"                 backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not mac ones for example.\n"
+"         -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; defined where %%b is.\n"
+"\n"
+"         -> %%d: date (UNIX-like epoch)\n"
+"         -> %%r: application age (time elapsed since the beginning of the application)\n");
 }
 
 /* Parse the command line, looking for options */