PLD: usage/help updates

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

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-08 23:23:55 -08:00
parent 2a76c1bcf9
commit 973cd9a299
2 changed files with 13 additions and 12 deletions

View File

@ -76,7 +76,7 @@ COMMAND_HANDLER(handle_pld_device_command)
/* register pld specific commands */ /* register pld specific commands */
int retval; int retval;
if (pld_drivers[i]->commands) { if (pld_drivers[i]->commands) {
retval = register_commands(CMD_CTX, NULL, retval = register_commands(CMD_CTX, NULL,
pld_drivers[i]->commands); pld_drivers[i]->commands);
if (ERROR_OK != retval) if (ERROR_OK != retval)
{ {
@ -89,10 +89,12 @@ COMMAND_HANDLER(handle_pld_device_command)
c->driver = pld_drivers[i]; c->driver = pld_drivers[i];
c->next = NULL; c->next = NULL;
retval = CALL_COMMAND_HANDLER(pld_drivers[i]->pld_device_command, c); retval = CALL_COMMAND_HANDLER(
pld_drivers[i]->pld_device_command, c);
if (ERROR_OK != retval) if (ERROR_OK != retval)
{ {
LOG_ERROR("'%s' driver rejected pld device", CMD_ARGV[0]); LOG_ERROR("'%s' driver rejected pld device",
CMD_ARGV[0]);
free(c); free(c);
return ERROR_OK; return ERROR_OK;
} }
@ -191,16 +193,16 @@ COMMAND_HANDLER(handle_pld_load_command)
static const struct command_registration pld_exec_command_handlers[] = { static const struct command_registration pld_exec_command_handlers[] = {
{ {
.name = "devices", .name = "devices",
.handler = &handle_pld_devices_command, .handler = handle_pld_devices_command,
.mode = COMMAND_EXEC, .mode = COMMAND_EXEC,
.help = "list configured pld devices", .help = "list configured pld devices",
}, },
{ {
.name = "load", .name = "load",
.handler = &handle_pld_load_command, .handler = handle_pld_load_command,
.mode = COMMAND_EXEC, .mode = COMMAND_EXEC,
.help = "load configuration file into PLD", .help = "load configuration file into PLD",
.usage = "<device#> <file>", .usage = "pld_num filename",
}, },
COMMAND_REGISTRATION_DONE COMMAND_REGISTRATION_DONE
}; };
@ -234,14 +236,14 @@ static const struct command_registration pld_config_command_handlers[] = {
{ {
.name = "device", .name = "device",
.mode = COMMAND_CONFIG, .mode = COMMAND_CONFIG,
.handler = &handle_pld_device_command, .handler = handle_pld_device_command,
.help = "configure a PLD device", .help = "configure a PLD device",
.usage = "<driver> ...", .usage = "driver_name [driver_args ... ]",
}, },
{ {
.name = "init", .name = "init",
.mode = COMMAND_CONFIG, .mode = COMMAND_CONFIG,
.handler = &handle_pld_init_command, .handler = handle_pld_init_command,
.help = "initialize PLD devices", .help = "initialize PLD devices",
}, },
COMMAND_REGISTRATION_DONE COMMAND_REGISTRATION_DONE
@ -251,7 +253,6 @@ static const struct command_registration pld_command_handler[] = {
.name = "pld", .name = "pld",
.mode = COMMAND_ANY, .mode = COMMAND_ANY,
.help = "programmable logic device commands", .help = "programmable logic device commands",
.chain = pld_config_command_handlers, .chain = pld_config_command_handlers,
}, },
COMMAND_REGISTRATION_DONE COMMAND_REGISTRATION_DONE

View File

@ -237,9 +237,9 @@ static const struct command_registration virtex2_exec_command_handlers[] = {
{ {
.name = "read_stat", .name = "read_stat",
.mode = COMMAND_EXEC, .mode = COMMAND_EXEC,
.handler = &virtex2_handle_read_stat_command, .handler = virtex2_handle_read_stat_command,
.help = "read status register", .help = "read status register",
.usage = "<device_id>", .usage = "pld_num",
}, },
COMMAND_REGISTRATION_DONE COMMAND_REGISTRATION_DONE
}; };