X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=doc%2FREADME.commands;h=716ad227aa1917261ccaf0bfd189f9f5693f9027;hb=42c8a112d2e90598f0933d085ab4e47b41ab2aba;hp=0ccadae0b718a65a736001255240f44ea82a6859;hpb=bea3d826203f90507ff32ed24bd0a3c53479e55c;p=oweals%2Fu-boot.git diff --git a/doc/README.commands b/doc/README.commands index 0ccadae0b7..716ad227aa 100644 --- a/doc/README.commands +++ b/doc/README.commands @@ -3,7 +3,7 @@ Command definition 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() or the -U_BOOT_CMD_COMPLETE macro to fill in a cmd_tbl_t struct. +U_BOOT_CMD_COMPLETE macro to fill in a struct cmd_tbl struct. U_BOOT_CMD(name, maxargs, repeatable, command, "usage", "help") U_BOOT_CMD_COMPLETE(name, maxargs, repeatable, command, "usage, "help", comp) @@ -31,7 +31,7 @@ comp: Pointer to the completion function. May be NULL. Sub-command definition ---------------------- -Likewise an array of cmd_tbl_t holding sub-commands can be created using either +Likewise an array of struct cmd_tbl holding sub-commands can be created using either of the following macros: * U_BOOT_CMD_MKENT(name, maxargs, repeatable, command, "usage", "help") @@ -40,14 +40,14 @@ of the following macros: This table has to be evaluated in the command function of the main command, e.g. - static cmd_tbl_t cmd_sub[] = { + static struct cmd_tbl cmd_sub[] = { U_BOOT_CMD_MKENT(foo, CONFIG_SYS_MAXARGS, 1, do_foo, "", ""), U_BOOT_CMD_MKENT(bar, CONFIG_SYS_MAXARGS, 1, do_bar, "", ""), }; - static int do_cmd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]) + static int do_cmd(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) { - cmd_tbl_t *cp; + struct cmd_tbl *cp; if (argc < 2) return CMD_RET_USAGE; @@ -67,8 +67,8 @@ This table has to be evaluated in the command function of the main command, e.g. Command function ---------------- -The commmand function pointer has to be of type -int (*cmd)(struct cmd_tbl_s *cmdtp, int flag, int argc, const char *argv[]); +The command function pointer has to be of type +int (*cmd)(struct cmd_tbl *cmdtp, int flag, int argc, const char *argv[]); cmdtp: Table entry describing the command (see above). @@ -83,9 +83,9 @@ argv: Arguments. Allowable return value are: -CMD_SUCCESS The command was successfully executed. +CMD_RET_SUCCESS The command was successfully executed. -CMD_FAILURE The command failed. +CMD_RET_FAILURE The command failed. CMD_RET_USAGE The command was called with invalid parameters. This value leads to the display of the usage string.