auracaster/openocd
3
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

src/server: usage/help/doc updates

Browse Source 
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>
This commit is contained in:
David Brownell
2010-01-09 00:55:41 -08:00
parent aafd3877e6
commit fc9a2d0e6f
5 changed files with 54 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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[] = {
{
.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 = "<port>",
.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
};