diff options
| author | Peter Meerwald <p.meerwald@bct-electronic.com> | 2012-02-08 05:31:52 +0000 |
|---|---|---|
| committer | Tom Rini <trini@ti.com> | 2012-02-14 11:02:46 -0700 |
| commit | 00309c67ab8c8a1d4447f643b318b1474926173a (patch) | |
| tree | 829febe0a777e0f69fb243d90cb29904f6098766 /doc/README.commands | |
| parent | 9a3aae22edf1eda6326cc51c28631ca5c23b7706 (diff) | |
| download | u-boot-00309c67ab8c8a1d4447f643b318b1474926173a.tar.gz u-boot-00309c67ab8c8a1d4447f643b318b1474926173a.tar.xz u-boot-00309c67ab8c8a1d4447f643b318b1474926173a.zip | |
doc: complete, typos
mention repeatable to README.commands and fix some typos
Signed-off-by: Peter Meerwald <p.meerwald@bct-electronic.com>
Acked-by: Mike Frysinger <vapier@gentoo.org>
Tested-by: Marek Vasut <marek.vasut@gmail.com>
Diffstat (limited to 'doc/README.commands')
| -rw-r--r-- | doc/README.commands | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/README.commands b/doc/README.commands index d678992d46..27815d2ba1 100644 --- a/doc/README.commands +++ b/doc/README.commands @@ -1,19 +1,19 @@ Commands are added to U-Boot by creating a new command structure. -This is done by first including command.h - -Then using the U_BOOT_CMD() macro to fill in a cmd_tbl_t struct. +This is done by first including command.h, then using the U_BOOT_CMD() macro +to fill in a cmd_tbl_t struct. U_BOOT_CMD(name,maxargs,repeatable,command,"usage","help") name: is the name of the commad. THIS IS NOT a string. -maxargs: the maximumn numbers of arguments this function takes +maxargs: the maximum number of arguments this function takes +repeatable: either 0 or 1 to indicate if autorepeat is allowed command: Function pointer (*cmd)(struct cmd_tbl_s *, int, int, char *[]); usage: Short description. This is a string -help: long description. This is a string +help: Long description. This is a string -**** Behinde the scene ****** +**** Behind the scene ****** The structure created is named with a special prefix (__u_boot_cmd_) and placed by the linker in a special section. |