zcy
/
tinyriscv-openocd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

src/server: usage/help/doc updates 

Make "usage" messages use the same EBNF as the User's Guide;
no angle brackets.  Improve and correct various helptexts.

Specifically for the port commands, clarify that the number
is optional, and omitting it causes the current number to be
displayed.

Don't use "&function"; a function's name is its address.
Remove a couple instances of pointless whitespace; shrink a
few overlong lines.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
__archive__
David Brownell 2010-01-09 00:55:41 -08:00
parent aafd3877e6
commit fc9a2d0e6f
5 changed files with 54 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/openocd.texi
View File

@ -1721,17 +1721,17 @@ In such cases, just specify the relevant port number as zero.
If you disable all access through TCP/IP, you will need to If you disable all access through TCP/IP, you will need to
use the command line @option{-pipe} option. use the command line @option{-pipe} option.
@deffn {Command} gdb_port (number) @deffn {Command} gdb_port [number]
@cindex GDB server @cindex GDB server
Specify or query the first port used for incoming GDB connections. Specify or query the first port used for incoming GDB connections.
The GDB port for the The GDB port for the
first target will be gdb_port, the second target will listen on gdb_port + 1, and so on. first target will be gdb_port, the second target will listen on gdb_port + 1, and so on.
When not specified during the configuration stage, When not specified during the configuration stage,
the port @var{number} defaults to 3333. the port @var{number} defaults to 3333.
When specified as zero, this port is not activated. When specified as zero, GDB remote access ports are not activated.
@end deffn @end deffn
@deffn {Command} tcl_port (number) @deffn {Command} tcl_port [number]
Specify or query the port used for a simplified RPC Specify or query the port used for a simplified RPC
connection that can be used by clients to issue TCL commands and get the connection that can be used by clients to issue TCL commands and get the
output from the Tcl engine. output from the Tcl engine.
@ -1741,7 +1741,7 @@ the port @var{number} defaults to 6666.
When specified as zero, this port is not activated. When specified as zero, this port is not activated.
@end deffn @end deffn
@deffn {Command} telnet_port (number) @deffn {Command} telnet_port [number]
Specify or query the Specify or query the
port on which to listen for incoming telnet connections. port on which to listen for incoming telnet connections.
This port is intended for interaction with one human through TCL commands. This port is intended for interaction with one human through TCL commands.

31
src/server/gdb_server.c
View File

@ -2412,7 +2412,7 @@ COMMAND_HANDLER(handle_gdb_breakpoint_override_command)
static const struct command_registration gdb_command_handlers[] = { static const struct command_registration gdb_command_handlers[] = {
{ {
.name = "gdb_sync", .name = "gdb_sync",
.handler = &handle_gdb_sync_command, .handler = handle_gdb_sync_command,
.mode = COMMAND_ANY, .mode = COMMAND_ANY,
.help = "next stepi will return immediately allowing " .help = "next stepi will return immediately allowing "
"GDB to fetch register state without affecting " "GDB to fetch register state without affecting "
@ -2420,40 +2420,41 @@ static const struct command_registration gdb_command_handlers[] = {
}, },
{ {
.name = "gdb_port", .name = "gdb_port",
.handler = &handle_gdb_port_command, .handler = handle_gdb_port_command,
.mode = COMMAND_ANY, .mode = COMMAND_ANY,
.help = "daemon configuration command gdb_port. No arguments reports " .help = "Display or specify base port on which to listen "
"GDB port.", "for incoming GDB connections. "
.usage = "<port>", "No arguments reports GDB port; zero disables.",
.usage = "[port_num]",
}, },
{ {
.name = "gdb_memory_map", .name = "gdb_memory_map",
.handler = &handle_gdb_memory_map_command, .handler = handle_gdb_memory_map_command,
.mode = COMMAND_CONFIG, .mode = COMMAND_CONFIG,
.help = "enable or disable memory map", .help = "enable or disable memory map",
.usage = "enable|disable" .usage = "('enable'|'disable')"
}, },
{ {
.name = "gdb_flash_program", .name = "gdb_flash_program",
.handler = &handle_gdb_flash_program_command, .handler = handle_gdb_flash_program_command,
.mode = COMMAND_CONFIG, .mode = COMMAND_CONFIG,
.help = "enable or disable flash program", .help = "enable or disable flash program",
.usage = "enable|disable" .usage = "('enable'|'disable')"
}, },
{ {
.name = "gdb_report_data_abort", .name = "gdb_report_data_abort",
.handler = &handle_gdb_report_data_abort_command, .handler = handle_gdb_report_data_abort_command,
.mode = COMMAND_CONFIG, .mode = COMMAND_CONFIG,
.help = "enable or disable reporting data aborts", .help = "enable or disable reporting data aborts",
.usage = "enable|disable" .usage = "('enable'|'disable')"
}, },
{ {
.name = "gdb_breakpoint_override", .name = "gdb_breakpoint_override",
.handler = &handle_gdb_breakpoint_override_command, .handler = handle_gdb_breakpoint_override_command,
.mode = COMMAND_EXEC, .mode = COMMAND_EXEC,
.help = "force type of breakpoint " .help = "Display or specify type of breakpoint "
"used by gdb 'break' commands.", "to be used by gdb 'break' commands.",
.usage = "hard|soft|disable", .usage = "('hard'|'soft'|'disable')"
}, },
COMMAND_REGISTRATION_DONE COMMAND_REGISTRATION_DONE
}; };

48
src/server/httpd.c
View File

@ -118,11 +118,11 @@ static int httpd_Jim_Command_writeform(Jim_Interp *interp, int argc,
// Find length // Find length
const char *data; const char *data;
int actual; int actual;
int retcode; int retcode;
const char *script = alloc_printf(
const char *script = alloc_printf("set dummy_val $httppostdata(%s); set dummy_val", "set dummy_val $httppostdata(%s); set dummy_val",
name); name);
retcode = Jim_Eval_Named(interp, script, __FILE__, __LINE__); retcode = Jim_Eval_Named(interp, script, __FILE__, __LINE__);
free((void *) script); free((void *) script);
if (retcode != JIM_OK) if (retcode != JIM_OK)
@ -154,27 +154,25 @@ httpd_Jim_Command_formfetch(Jim_Interp *interp,
int argc, int argc,
Jim_Obj *const *argv) Jim_Obj *const *argv)
{ {
if (argc != 2) if (argc != 2)
{ {
Jim_WrongNumArgs(interp, 1, argv, "method ?CMD_ARGV ...?"); Jim_WrongNumArgs(interp, 1, argv, "method ?CMD_ARGV ...?");
return JIM_ERR; return JIM_ERR;
} }
char *name = (char*)Jim_GetString(argv[1], NULL);
char *name = (char*)Jim_GetString(argv[1], NULL);
const char *script = alloc_printf(
"set dummy_val $httppostdata(%s); set dummy_val",
name);
int retcode = Jim_Eval_Named(interp, script, __FILE__, __LINE__);
const char *script = alloc_printf("set dummy_val $httppostdata(%s); set dummy_val", free((void *) script);
name); if (retcode != JIM_OK)
int retcode = Jim_Eval_Named(interp, script, __FILE__, __LINE__); Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
free((void *) script); else
if (retcode != JIM_OK) Jim_SetResult(interp, Jim_GetResult(interp));
{
Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
} else
{
Jim_SetResult(interp, Jim_GetResult(interp));
}
return JIM_OK; return JIM_OK;
} }
struct httpd_request struct httpd_request
@ -467,16 +465,16 @@ static struct MHD_Daemon * d;
static const struct command_registration httpd_command_handlers[] = { static const struct command_registration httpd_command_handlers[] = {
{ {
.name = "formfetch", .name = "formfetch",
.jim_handler = &httpd_Jim_Command_formfetch, .jim_handler = httpd_Jim_Command_formfetch,
.mode = COMMAND_EXEC, .mode = COMMAND_EXEC,
.usage = "<parameter_name>", .usage = "parameter_name",
.help = "Reads a posted form value.", .help = "Reads a posted form value.",
}, },
{ {
.name = "writeform", .name = "writeform",
.jim_handler = &httpd_Jim_Command_writeform, .jim_handler = httpd_Jim_Command_writeform,
.mode = COMMAND_EXEC, .mode = COMMAND_EXEC,
.usage = "<parameter_name> <file>", .usage = "parameter_name filename",
.help = "Writes a form value to a file.", .help = "Writes a form value to a file.",
}, },
COMMAND_REGISTRATION_DONE COMMAND_REGISTRATION_DONE

9
src/server/tcl_server.c
View File

@ -181,11 +181,12 @@ COMMAND_HANDLER(handle_tcl_port_command)
static const struct command_registration tcl_command_handlers[] = { static const struct command_registration tcl_command_handlers[] = {
{ {
.name = "tcl_port", .name = "tcl_port",
.handler = &handle_tcl_port_command, .handler = handle_tcl_port_command,
.mode = COMMAND_CONFIG, .mode = COMMAND_CONFIG,
.help = "port on which to listen " .help = "Specify port on which to listen "
"for incoming TCL syntax", "for incoming Tcl syntax. "
.usage = "<port>", "No arguments reports Tcl port; zero disables.",
.usage = "[port_num]",
}, },
COMMAND_REGISTRATION_DONE COMMAND_REGISTRATION_DONE
}; };

11
src/server/telnet_server.c
View File

@ -619,17 +619,18 @@ COMMAND_HANDLER(handle_exit_command)
static const struct command_registration telnet_command_handlers[] = { static const struct command_registration telnet_command_handlers[] = {
{ {
.name = "exit", .name = "exit",
.handler = &handle_exit_command, .handler = handle_exit_command,
.mode = COMMAND_EXEC, .mode = COMMAND_EXEC,
.help = "exit telnet session", .help = "exit telnet session",
}, },
{ {
.name = "telnet_port", .name = "telnet_port",
.handler = &handle_telnet_port_command, .handler = handle_telnet_port_command,
.mode = COMMAND_ANY, .mode = COMMAND_ANY,
.help = "port on which to listen " .help = "Specify port on which to listen "
"for incoming telnet connections", "for incoming telnet connections. "
.usage = "<port>", "No arguments reports telnet port; zero disables.",
.usage = "[port_num]",
}, },
COMMAND_REGISTRATION_DONE COMMAND_REGISTRATION_DONE
}; };