]> git.ipfire.org Git - people/ms/u-boot.git/commitdiff
doc: complete, typos
authorPeter Meerwald <p.meerwald@bct-electronic.com>
Wed, 8 Feb 2012 05:31:52 +0000 (05:31 +0000)
committerTom Rini <trini@ti.com>
Tue, 14 Feb 2012 18:02:46 +0000 (11:02 -0700)
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>
doc/README.commands

index d678992d46fe51cebcb19041d031aaa6216e5eb1..27815d2ba18faada4344e68ed65ac3b188569797 100644 (file)
@@ -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.