doxygen: use correct comment syntax
[openocd.git] / src / helper / options.c
index 3a95df46d0799923f12af0f3b7c165eaf0c24f4b..e31066d7997c12d824f37d50f449455beaeb2f9a 100644 (file)
@@ -2,7 +2,7 @@
  *   Copyright (C) 2004, 2005 by Dominic Rath                              *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   Copyright (C) 2007-2010 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   Free Software Foundation, Inc.,                                       *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
 #include "configuration.h"
-// @todo the inclusion of server.h here is a layering violation
+/* @todo the inclusion of server.h here is a layering violation */
 #include <server/server.h>
 
 #include <getopt.h>
 
 static int help_flag, version_flag;
 
-static const struct option long_options[] =
-{
-       {"help",        no_argument,            &help_flag,     1},
-       {"version",     no_argument,            &version_flag,  1},
-       {"debug",       optional_argument,      0,              'd'},
-       {"file",        required_argument,      0,              'f'},
-       {"search",      required_argument,      0,              's'},
-       {"log_output",  required_argument,      0,      'l'},
-       {"command",     required_argument,      0,              'c'},
-       {"pipe",        no_argument,            0,              'p'},
+static const struct option long_options[] = {
+       {"help",                no_argument,                    &help_flag,             1},
+       {"version",             no_argument,                    &version_flag,  1},
+       {"debug",               optional_argument,              0,                              'd'},
+       {"file",                required_argument,              0,                              'f'},
+       {"search",              required_argument,              0,                              's'},
+       {"log_output",  required_argument,              0,                              'l'},
+       {"command",             required_argument,              0,                              'c'},
+       {"pipe",                no_argument,                    0,                              'p'},
        {0, 0, 0, 0}
 };
 
-int configuration_output_handler(struct command_context *context, const charline)
+int configuration_output_handler(struct command_context *context, const char *line)
 {
        LOG_USER_N("%s", line);
 
@@ -64,8 +64,8 @@ static void add_default_dirs(void)
         * target\at91eb40a.cfg
         */
        {
-               char strExePath [MAX_PATH];
-               GetModuleFileName (NULL, strExePath, MAX_PATH);
+               char strExePath[MAX_PATH];
+               GetModuleFileName(NULL, strExePath, MAX_PATH);
                /* Either this code will *always* work or it will SEGFAULT giving
                 * excellent information on the culprit.
                 */
@@ -84,11 +84,11 @@ static void add_default_dirs(void)
         * share/openocd/scripts/target/at91eb40a.cfg
         */
        {
-               char strExePath [MAX_PATH];
+               char strExePath[MAX_PATH];
                char *p;
-               GetModuleFileName (NULL, strExePath, MAX_PATH);
+               GetModuleFileName(NULL, strExePath, MAX_PATH);
                *strrchr(strExePath, '\\') = 0;
-               strcat(strExePath, "/../share/"PACKAGE"/scripts");
+               strcat(strExePath, "/../share/"PACKAGE "/scripts");
                for (p = strExePath; *p; p++) {
                        if (*p == '\\')
                                *p = '/';
@@ -104,14 +104,12 @@ static void add_default_dirs(void)
 
        const char *home = getenv("HOME");
 
-       if (home) 
-       {
+       if (home) {
                char *path;
 
                path = alloc_printf("%s/.openocd", home);
 
-               if (path) 
-               {
+               if (path) {
                        add_script_search_dir(path);
                        free(path);
                }
@@ -127,8 +125,7 @@ int parse_cmdline_args(struct command_context *cmd_ctx, int argc, char *argv[])
        int c;
        char command_buffer[128];
 
-       while (1)
-       {
+       while (1) {
                /* getopt_long stores the option index here. */
                int option_index = 0;
 
@@ -138,58 +135,52 @@ int parse_cmdline_args(struct command_context *cmd_ctx, int argc, char *argv[])
                if (c == -1)
                        break;
 
-               switch (c)
-               {
+               switch (c) {
                        case 0:
                                break;
-                       case 'h':       /* --help | -h */
+                       case 'h':               /* --help | -h */
                                help_flag = 1;
                                break;
-                       case 'v':       /* --version | -v */
+                       case 'v':               /* --version | -v */
                                version_flag = 1;
                                break;
-                       case 'f':       /* --file | -f */
+                       case 'f':               /* --file | -f */
                        {
                                snprintf(command_buffer, 128, "script {%s}", optarg);
                                add_config_command(command_buffer);
                                break;
                        }
-                       case 's':       /* --search | -s */
+                       case 's':               /* --search | -s */
                                add_script_search_dir(optarg);
                                break;
-                       case 'd':       /* --debug | -d */
+                       case 'd':               /* --debug | -d */
                                if (optarg)
                                        snprintf(command_buffer, 128, "debug_level %s", optarg);
                                else
                                        snprintf(command_buffer, 128, "debug_level 3");
                                command_run_line(cmd_ctx, command_buffer);
                                break;
-                       case 'l':       /* --log_output | -l */
-                               if (optarg)
-                               {
+                       case 'l':               /* --log_output | -l */
+                               if (optarg) {
                                        snprintf(command_buffer, 128, "log_output %s", optarg);
                                        command_run_line(cmd_ctx, command_buffer);
                                }
                                break;
-                       case 'c':       /* --command | -c */
+                       case 'c':               /* --command | -c */
                                if (optarg)
-                               {
-                                       add_config_command(optarg);
-                               }
+                                   add_config_command(optarg);
                                break;
-                       case 'p':       /* --pipe | -p */
-#if BUILD_ECOSBOARD == 1
-                               /* pipes unsupported on hosted platforms */
-                               LOG_WARNING("pipes not supported on this platform");
-#else
-                               server_use_pipes = 1;
-#endif
+                       case 'p':
+                               /* to replicate the old syntax this needs to be synchronous
+                                * otherwise the gdb stdin will overflow with the warning message */
+                               command_run_line(cmd_ctx, "gdb_port pipe; log_output openocd.log");
+                               LOG_WARNING("deprecated option: -p/--pipe. Use '-c \"gdb_port pipe; "
+                                               "log_output openocd.log\"' instead.");
                                break;
                }
        }
 
-       if (help_flag)
-       {
+       if (help_flag) {
                LOG_OUTPUT("Open On-Chip Debugger\nLicensed under GNU GPL v2\n");
                LOG_OUTPUT("--help       | -h\tdisplay this help\n");
                LOG_OUTPUT("--version    | -v\tdisplay OpenOCD version\n");
@@ -198,14 +189,12 @@ int parse_cmdline_args(struct command_context *cmd_ctx, int argc, char *argv[])
                LOG_OUTPUT("--debug      | -d\tset debug level <0-3>\n");
                LOG_OUTPUT("--log_output | -l\tredirect log output to file <name>\n");
                LOG_OUTPUT("--command    | -c\trun <command>\n");
-               LOG_OUTPUT("--pipe       | -p\tuse pipes for gdb communication\n");
                exit(-1);
        }
 
-       if (version_flag)
-       {
+       if (version_flag) {
                /* Nothing to do, version gets printed automatically. */
-               // It is not an error to request the VERSION number.
+               /* It is not an error to request the VERSION number. */
                exit(0);
        }
 

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)