From fc9a2d0e6f3270dc86f84749ad10dd79d97c8392 Mon Sep 17 00:00:00 2001 From: David Brownell Date: Sat, 9 Jan 2010 00:55:41 -0800 Subject: 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 --- src/server/gdb_server.c | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) (limited to 'src/server/gdb_server.c') diff --git a/src/server/gdb_server.c b/src/server/gdb_server.c index 96b9dbf1..08daa68a 100644 --- a/src/server/gdb_server.c +++ b/src/server/gdb_server.c @@ -2412,7 +2412,7 @@ COMMAND_HANDLER(handle_gdb_breakpoint_override_command) static const struct command_registration gdb_command_handlers[] = { { .name = "gdb_sync", - .handler = &handle_gdb_sync_command, + .handler = handle_gdb_sync_command, .mode = COMMAND_ANY, .help = "next stepi will return immediately allowing " "GDB to fetch register state without affecting " @@ -2420,40 +2420,41 @@ static const struct command_registration gdb_command_handlers[] = { }, { .name = "gdb_port", - .handler = &handle_gdb_port_command, + .handler = handle_gdb_port_command, .mode = COMMAND_ANY, - .help = "daemon configuration command gdb_port. No arguments reports " - "GDB port.", - .usage = "", + .help = "Display or specify base port on which to listen " + "for incoming GDB connections. " + "No arguments reports GDB port; zero disables.", + .usage = "[port_num]", }, { .name = "gdb_memory_map", - .handler = &handle_gdb_memory_map_command, + .handler = handle_gdb_memory_map_command, .mode = COMMAND_CONFIG, .help = "enable or disable memory map", - .usage = "enable|disable" + .usage = "('enable'|'disable')" }, { .name = "gdb_flash_program", - .handler = &handle_gdb_flash_program_command, + .handler = handle_gdb_flash_program_command, .mode = COMMAND_CONFIG, .help = "enable or disable flash program", - .usage = "enable|disable" + .usage = "('enable'|'disable')" }, { .name = "gdb_report_data_abort", - .handler = &handle_gdb_report_data_abort_command, + .handler = handle_gdb_report_data_abort_command, .mode = COMMAND_CONFIG, .help = "enable or disable reporting data aborts", - .usage = "enable|disable" + .usage = "('enable'|'disable')" }, { .name = "gdb_breakpoint_override", - .handler = &handle_gdb_breakpoint_override_command, + .handler = handle_gdb_breakpoint_override_command, .mode = COMMAND_EXEC, - .help = "force type of breakpoint " - "used by gdb 'break' commands.", - .usage = "hard|soft|disable", + .help = "Display or specify type of breakpoint " + "to be used by gdb 'break' commands.", + .usage = "('hard'|'soft'|'disable')" }, COMMAND_REGISTRATION_DONE }; -- cgit v1.2.3-18-g5258