summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/manual/primer/commands.txt13
-rw-r--r--doc/manual/style.txt2
-rw-r--r--src/hello.c8
3 files changed, 14 insertions, 9 deletions
diff --git a/doc/manual/primer/commands.txt b/doc/manual/primer/commands.txt
index 61697349..5f89d506 100644
--- a/doc/manual/primer/commands.txt
+++ b/doc/manual/primer/commands.txt
@@ -68,9 +68,9 @@ static const struct command_registration hello_command_handlers[] = {
{
.name = "hello",
.mode = COMMAND_ANY,
- .handler = &handle_hello_command,
- .help = "print a warm greetings",
- .usage = "[<name>]",
+ .handler = handle_hello_command,
+ .help = "print a warm greeting",
+ .usage = "[name]",
},
{
.chain = foo_command_handlers,
@@ -84,7 +84,12 @@ int hello_register_commands(struct command_context_s *cmd_ctx)
}
@endcode
-That's it! The command should now be registered and avaiable to scripts.
+Note that the "usage" text should use the same EBNF that's found
+in the User's Guide: literals in 'single quotes', sequences of
+optional parameters in [square brackets], and alternatives in
+(parentheses|with|vertical bars), and so forth. No angle brackets.
+
+That's it! The command should now be registered and available to scripts.
@section primercmdchain Command Chaining
diff --git a/doc/manual/style.txt b/doc/manual/style.txt
index 71bb5f6b..87b1e6ba 100644
--- a/doc/manual/style.txt
+++ b/doc/manual/style.txt
@@ -308,7 +308,7 @@ For technical reference material:
- Else it's a "Config Command" if it must be used before the
configuration stage completes.
- For a "Driver", list its name.
- - Use BNF style regular expressions to define parameters:
+ - Use EBNF style regular expressions to define parameters:
brackets around zero-or-one choices, parentheses around
exactly-one choices.
- Use \@option, \@file, \@var and other mechanisms where appropriate.
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",