From: Peter Meerwald
Date: Wed, 8 Feb 2012 05:31:52 +0000 (+0000)
Subject: doc: complete, typos
X-Git-Url: http://git.dujemihanovic.xyz/?a=commitdiff_plain;h=00309c67ab8c8a1d4447f643b318b1474926173a;p=u-boot.git
doc: complete, typos
mention repeatable to README.commands and fix some typos
Signed-off-by: Peter Meerwald
Acked-by: Mike Frysinger
Tested-by: Marek Vasut
---
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.