diff options
| author | David Brownell <dbrownell@users.sourceforge.net> | 2010-01-08 23:13:39 -0800 |
|---|---|---|
| committer | David Brownell <dbrownell@users.sourceforge.net> | 2010-01-08 23:13:39 -0800 |
| commit | ae710059291ba9830a9b20d899bdef6a5122dd73 (patch) | |
| tree | 2fcb7c5fb6d903cca7c842797392e90cd8333179 /src/hello.c | |
| parent | b800eb0336a190ed53da90a2b7216a35bfbfdb23 (diff) | |
| download | openocd+libswd-ae710059291ba9830a9b20d899bdef6a5122dd73.tar.gz openocd+libswd-ae710059291ba9830a9b20d899bdef6a5122dd73.tar.bz2 openocd+libswd-ae710059291ba9830a9b20d899bdef6a5122dd73.tar.xz openocd+libswd-ae710059291ba9830a9b20d899bdef6a5122dd73.zip | |
Doc/examples: clarify usage messages
Update/bugfix the "hello" example; emphasize using EBNF syntax,
matching the User's Guide. Correct the Texinfo style guide to
say EBNF, not BNF.
Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
Diffstat (limited to 'src/hello.c')
| -rw-r--r-- | src/hello.c | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/hello.c b/src/hello.c index 0cd06adc..8cd5fabb 100644 --- a/src/hello.c +++ b/src/hello.c @@ -58,14 +58,14 @@ static const struct command_registration foo_command_handlers[] = { .name = "bar", .handler = &handle_foo_command, .mode = COMMAND_ANY, - .usage = "<address> [enable|disable]", + .usage = "address ['enable'|'disable']", .help = "an example command", }, { .name = "baz", .handler = &handle_foo_command, .mode = COMMAND_ANY, - .usage = "<address> [enable|disable]", + .usage = "address ['enable'|'disable']", .help = "a sample command", }, { @@ -107,10 +107,10 @@ COMMAND_HANDLER(handle_hello_command) const struct command_registration hello_command_handlers[] = { { .name = "hello", - .handler = &handle_hello_command, + .handler = handle_hello_command, .mode = COMMAND_ANY, .help = "prints a warm welcome", - .usage = "[<name>]", + .usage = "[name]", }, { .name = "foo", |