summaryrefslogtreecommitdiff
path: root/doc/manual/primer
diff options
context:
space:
mode:
authorDavid Brownell <dbrownell@users.sourceforge.net>2010-01-08 23:13:39 -0800
committerDavid Brownell <dbrownell@users.sourceforge.net>2010-01-08 23:13:39 -0800
commitae710059291ba9830a9b20d899bdef6a5122dd73 (patch)
tree2fcb7c5fb6d903cca7c842797392e90cd8333179 /doc/manual/primer
parentb800eb0336a190ed53da90a2b7216a35bfbfdb23 (diff)
downloadopenocd_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 'doc/manual/primer')
-rw-r--r--doc/manual/primer/commands.txt13
1 files changed, 9 insertions, 4 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