common/cmd_help.c

   1 /*
   2  * Copyright 2000-2009
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * See file CREDITS for list of people who contributed to this
   6  * project.
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  21  * MA 02111-1307 USA
  22  */
  23
  24 #include <common.h>
  25 #include <command.h>
  26
  27 int do_help(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
  28 {
  29         cmd_tbl_t *start = ll_entry_start(cmd_tbl_t, cmd);
  30         const int len = ll_entry_count(cmd_tbl_t, cmd);
  31         return _do_help(start, len, cmdtp, flag, argc, argv);
  32 }
  33
  34 U_BOOT_CMD(
  35         help,   CONFIG_SYS_MAXARGS,     1,      do_help,
  36         "print command description/usage",
  37         "\n"
  38         "       - print brief description of all commands\n"
  39         "help command ...\n"
  40         "       - print detailed usage of 'command'"
  41 );
  42
  43 /* This does not use the U_BOOT_CMD macro as ? can't be used in symbol names */
  44 ll_entry_declare(cmd_tbl_t, question_mark, cmd, cmd) = {
  45         "?",    CONFIG_SYS_MAXARGS,     1,      do_help,
  46         "alias for 'help'",
  47 #ifdef  CONFIG_SYS_LONGHELP
  48         ""
  49 #endif /* CONFIG_SYS_LONGHELP */
  50 };