ARM ADIv5: add comments

[fw/openocd] / src / helper / log.c

diff --git a/src/helper/log.c b/src/helper/log.c
index 27fa8317aa6e0526037257affc9e14d1a3a8ddfa..7450fef50b1d4e1e664fbf074e144e0a55898a0b 100644 (file)
--- a/src/helper/log.c
+++ b/src/helper/log.c
@@ -29,7 +29,7 @@
 
 #include "time_support.h"
 // @todo the inclusion of server.h here is a layering violation
-#include "server.h"
+#include <server/server.h>
 
 #include <stdarg.h>
 
@@ -286,13 +286,16 @@ COMMAND_HANDLER(handle_debug_level_command)
 
        if (debug_level >= LOG_LVL_DEBUG && server_use_pipes == 1)
        {
-               /* if we are enabling debug info then we need to write to a log file
-                * otherwise the pipe will get full and cause issues with gdb */
+               /* if we are enabling debug info then we need to write to a
+                * log file otherwise the pipe will get full and cause issues
+                * with gdb
+                */
                FILE* file = fopen("openocd.log", "w");
                if (file)
                {
                        log_output = file;
-                       LOG_WARNING("enabling log output as we are using pipes");
+                       LOG_WARNING("enabling logfile output because "
+                               "we are using pipes to talk to GDB.");
                }
        }
 
@@ -319,17 +322,19 @@ COMMAND_HANDLER(handle_log_output_command)
 static struct command_registration log_command_handlers[] = {
        {
                .name = "log_output",
-               .handler = &handle_log_output_command,
+               .handler = handle_log_output_command,
                .mode = COMMAND_ANY,
                .help = "redirect logging to a file (default: stderr)",
-               .usage = "<file_name>",
+               .usage = "file_name",
        },
        {
                .name = "debug_level",
-               .handler = &handle_debug_level_command,
+               .handler = handle_debug_level_command,
                .mode = COMMAND_ANY,
-               .help = "sets the verbosity level of debugging output",
-               .usage = "<level:0-3>",
+               .help = "Sets the verbosity level of debugging output. "
+                       "0 shows errors only; 1 adds warnings; "
+                       "2 (default) adds other info; 3 adds debugging.",
+               .usage = "number",
        },
        COMMAND_REGISTRATION_DONE
 };
@@ -346,6 +351,19 @@ void log_init(void)
        if (debug_level == -1)
                debug_level = LOG_LVL_INFO;
 
+       char *debug_env = getenv("OPENOCD_DEBUG_LEVEL");
+       if (NULL != debug_env)
+       {
+               int value;
+               int retval = parse_int(debug_env, &value);
+               if (ERROR_OK == retval &&
+                               debug_level >= LOG_LVL_SILENT &&
+                               debug_level <= LOG_LVL_DEBUG)
+               {
+                       debug_level = value;
+               }
+       }
+
        if (log_output == NULL)
                log_output = stderr;