[PATCH v2 1/2] cmd: Introduce CMD_HELP

[Mattijs Korpershoek]

Hi Michal,

Thank you for the patch.

On Mon, Jun 30, 2025 at 14:21, Michal Simek <michal.simek at amd.com> wrote:

> Add option to disable help command in size constrained systems to save some
> space. There is also no need to have ifdefs around CMDLINE because all
> commands bepends on it.

s/bepends/depends/

> And also mark cmd_help dependency in test_help.py.
>
> Signed-off-by: Michal Simek <michal.simek at amd.com>
> Reviewed-by: Peter Robinson <pbrobinson at gmail.com>

Reviewed-by: Mattijs Korpershoek <mkorpershoek at kernel.org>

> ---
>
> Changes in v2:
> - Remove CONFIG_CMDLINE ifdefs from code.
> - Update test_help.
>
>  cmd/Kconfig                | 6 ++++++
>  cmd/Makefile               | 2 +-
>  cmd/help.c                 | 6 ------
>  test/py/tests/test_help.py | 1 +
>  4 files changed, 8 insertions(+), 7 deletions(-)
>
> diff --git a/cmd/Kconfig b/cmd/Kconfig
> index 4eb0140c10a1..ee3fbe6a4f2b 100644
> --- a/cmd/Kconfig
> +++ b/cmd/Kconfig
> @@ -189,6 +189,12 @@ config CMD_FWU_METADATA
>  	help
>  	  Command to read the metadata and dump it's contents
>  
> +config CMD_HELP
> +	bool "help"
> +	default y
> +	help
> +	  Command to show help information about other commands.
> +
>  config CMD_HISTORY
>  	bool "history"
>  	depends on CMDLINE_EDITING
> diff --git a/cmd/Makefile b/cmd/Makefile
> index 80cf70b7fe8c..718eff4ed197 100644
> --- a/cmd/Makefile
> +++ b/cmd/Makefile
> @@ -7,7 +7,7 @@ ifndef CONFIG_XPL_BUILD
>  # core command
>  obj-y += boot.o
>  obj-$(CONFIG_CMD_BOOTM) += bootm.o
> -obj-y += help.o
> +obj-$(CONFIG_CMD_HELP) += help.o
>  obj-y += panic.o
>  obj-y += version.o
>  
> diff --git a/cmd/help.c b/cmd/help.c
> index 56579e28d31d..1be83ba607d4 100644
> --- a/cmd/help.c
> +++ b/cmd/help.c
> @@ -9,13 +9,9 @@
>  static int do_help(struct cmd_tbl *cmdtp, int flag, int argc,
>  		   char *const argv[])
>  {
> -#ifdef CONFIG_CMDLINE
>  	struct cmd_tbl *start = ll_entry_start(struct cmd_tbl, cmd);
>  	const int len = ll_entry_count(struct cmd_tbl, cmd);
>  	return _do_help(start, len, cmdtp, flag, argc, argv);
> -#else
> -	return 0;
> -#endif
>  }
>  
>  U_BOOT_CMD(
> @@ -27,7 +23,6 @@ U_BOOT_CMD(
>  	"	- print detailed usage of 'command'"
>  );
>  
> -#ifdef CONFIG_CMDLINE
>  /*
>   * This does not use the U_BOOT_CMD macro as ? can't be used in symbol names
>   * nor can we rely on the CONFIG_SYS_LONGHELP helper macro
> @@ -39,4 +34,3 @@ ll_entry_declare(struct cmd_tbl, question_mark, cmd) = {
>  	""
>  #endif /* CONFIG_SYS_LONGHELP */
>  };
> -#endif
> diff --git a/test/py/tests/test_help.py b/test/py/tests/test_help.py
> index 12cb36b7b985..afb57201ba38 100644
> --- a/test/py/tests/test_help.py
> +++ b/test/py/tests/test_help.py
> @@ -4,6 +4,7 @@
>  
>  import pytest
>  
> + at pytest.mark.buildconfigspec('cmd_help')
>  def test_help(ubman):
>      """Test that the "help" command can be executed."""
>  
> -- 
> 2.43.0
>
> base-commit: 40ef75b0796307f718a4b424b5e52e79b36ae2f4