cmd/help.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright 2000-2009
   4  * Wolfgang Denk, DENX Software Engineering, [email protected].
   5  */
   6
   7 #include <command.h>
   8
   9 static int do_help(struct cmd_tbl *cmdtp, int flag, int argc,
  10                    char *const argv[])
  11 {
  12 #ifdef CONFIG_CMDLINE
  13         struct cmd_tbl *start = ll_entry_start(struct cmd_tbl, cmd);
  14         const int len = ll_entry_count(struct cmd_tbl, cmd);
  15         return _do_help(start, len, cmdtp, flag, argc, argv);
  16 #else
  17         return 0;
  18 #endif
  19 }
  20
  21 U_BOOT_CMD(
  22         help,   CONFIG_SYS_MAXARGS,     1,      do_help,
  23         "print command description/usage",
  24         "\n"
  25         "       - print brief description of all commands\n"
  26         "help command ...\n"
  27         "       - print detailed usage of 'command'"
  28 );
  29
  30 #ifdef CONFIG_CMDLINE
  31 /*
  32  * This does not use the U_BOOT_CMD macro as ? can't be used in symbol names
  33  * nor can we rely on the CONFIG_SYS_LONGHELP helper macro
  34  */
  35 ll_entry_declare(struct cmd_tbl, question_mark, cmd) = {
  36         "?",    CONFIG_SYS_MAXARGS, cmd_always_repeatable,      do_help,
  37         "alias for 'help'",
  38 #ifdef  CONFIG_SYS_LONGHELP
  39         ""
  40 #endif /* CONFIG_SYS_LONGHELP */
  41 };
  42 #endif