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>
This commit is contained in:
David Brownell
2010-01-08 23:13:39 -08:00
parent b800eb0336
commit ae71005929
3 changed files with 14 additions and 9 deletions
+4 -4
View File
@@ -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",