summaryrefslogtreecommitdiff
path: root/doc/README.commands
diff options
context:
space:
mode:
authorWolfgang Denk <wd@denx.de>2012-02-17 23:52:52 +0100
committerWolfgang Denk <wd@denx.de>2012-02-17 23:52:52 +0100
commitdbe20fc79736d4f99a9bfaafeae600c9348504df (patch)
treea1c18bc78442d42cc174c5fbe999e62545631218 /doc/README.commands
parente390e8709149664ff96cf19384264c84573f3082 (diff)
parentd1f862f97e49ae7a0a07187779bc4c19b16f558c (diff)
Merge branch 'trini@ti.com' of git://git.denx.de/u-boot-staging
* 'trini@ti.com' of git://git.denx.de/u-boot-staging: usb_ether: fix typo cmd_eeprom: typo doc: complete, typos
Diffstat (limited to 'doc/README.commands')
-rw-r--r--doc/README.commands12
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.