[PATCH v2 1/2] cmd: Introduce CMD_HELP

[PATCH v2 1/2] cmd: Introduce CMD_HELP

[Michal Simek]

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.
And also mark cmd_help dependency in test_help.py.

Signed-off-by: Michal Simek <michal.simek@amd.com>
Reviewed-by: Peter Robinson <pbrobinson@gmail.com>
---

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
 
+@pytest.mark.buildconfigspec('cmd_help')
 def test_help(ubman):
     """Test that the "help" command can be executed."""
 
-- 
2.43.0

base-commit: 40ef75b0796307f718a4b424b5e52e79b36ae2f4

[PATCH v2 2/2] xilinx: Disable help command for all mini configurations

[Michal Simek]

There is no reason to have help command available because none is calling
it and only make binary bigger that's why disable it.

Signed-off-by: Michal Simek <michal.simek@amd.com>
---

(no changes since v1)

 configs/amd_versal2_mini_defconfig               | 1 +
 configs/amd_versal2_mini_emmc_defconfig          | 1 +
 configs/amd_versal2_mini_ospi_defconfig          | 1 +
 configs/amd_versal2_mini_qspi_defconfig          | 1 +
 configs/xilinx_versal_mini_defconfig             | 1 +
 configs/xilinx_versal_mini_emmc0_defconfig       | 1 +
 configs/xilinx_versal_mini_emmc1_defconfig       | 1 +
 configs/xilinx_versal_mini_ospi_defconfig        | 1 +
 configs/xilinx_versal_mini_qspi_defconfig        | 1 +
 configs/xilinx_versal_net_mini_defconfig         | 1 +
 configs/xilinx_versal_net_mini_emmc_defconfig    | 1 +
 configs/xilinx_versal_net_mini_ospi_defconfig    | 1 +
 configs/xilinx_versal_net_mini_qspi_defconfig    | 1 +
 configs/xilinx_zynqmp_mini_defconfig             | 1 +
 configs/xilinx_zynqmp_mini_emmc0_defconfig       | 1 +
 configs/xilinx_zynqmp_mini_emmc1_defconfig       | 1 +
 configs/xilinx_zynqmp_mini_nand_defconfig        | 1 +
 configs/xilinx_zynqmp_mini_nand_single_defconfig | 1 +
 configs/xilinx_zynqmp_mini_qspi_defconfig        | 1 +
 19 files changed, 19 insertions(+)

diff --git a/configs/amd_versal2_mini_defconfig b/configs/amd_versal2_mini_defconfig
index 181866ba6973..e0f43352236f 100644
--- a/configs/amd_versal2_mini_defconfig
+++ b/configs/amd_versal2_mini_defconfig
@@ -32,6 +32,7 @@ CONFIG_BOARD_EARLY_INIT_R=y
 # CONFIG_SYS_LONGHELP is not set
 CONFIG_SYS_PROMPT="versal2> "
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/amd_versal2_mini_emmc_defconfig b/configs/amd_versal2_mini_emmc_defconfig
index 1c5fe4b84ce5..d95c4b3d199f 100644
--- a/configs/amd_versal2_mini_emmc_defconfig
+++ b/configs/amd_versal2_mini_emmc_defconfig
@@ -26,6 +26,7 @@ CONFIG_BOARD_EARLY_INIT_R=y
 CONFIG_SYS_PROMPT="versal2> "
 # CONFIG_CMD_BDI is not set
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/amd_versal2_mini_ospi_defconfig b/configs/amd_versal2_mini_ospi_defconfig
index 5d3d0fb5231a..cd59e0fc1a98 100644
--- a/configs/amd_versal2_mini_ospi_defconfig
+++ b/configs/amd_versal2_mini_ospi_defconfig
@@ -30,6 +30,7 @@ CONFIG_BOARD_EARLY_INIT_R=y
 # CONFIG_SYS_LONGHELP is not set
 CONFIG_SYS_PROMPT="versal2> "
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/amd_versal2_mini_qspi_defconfig b/configs/amd_versal2_mini_qspi_defconfig
index a9fb217b286f..03f3bd488061 100644
--- a/configs/amd_versal2_mini_qspi_defconfig
+++ b/configs/amd_versal2_mini_qspi_defconfig
@@ -30,6 +30,7 @@ CONFIG_BOARD_EARLY_INIT_R=y
 # CONFIG_SYS_LONGHELP is not set
 CONFIG_SYS_PROMPT="versal2> "
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/xilinx_versal_mini_defconfig b/configs/xilinx_versal_mini_defconfig
index 296c404d15ab..59f33f669cbe 100644
--- a/configs/xilinx_versal_mini_defconfig
+++ b/configs/xilinx_versal_mini_defconfig
@@ -33,6 +33,7 @@ CONFIG_CLOCKS=y
 # CONFIG_SYS_LONGHELP is not set
 CONFIG_SYS_PROMPT="Versal> "
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/xilinx_versal_mini_emmc0_defconfig b/configs/xilinx_versal_mini_emmc0_defconfig
index 36bd519af0c5..92d08120237e 100644
--- a/configs/xilinx_versal_mini_emmc0_defconfig
+++ b/configs/xilinx_versal_mini_emmc0_defconfig
@@ -31,6 +31,7 @@ CONFIG_CLOCKS=y
 CONFIG_SYS_PROMPT="Versal> "
 # CONFIG_CMD_BDI is not set
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/xilinx_versal_mini_emmc1_defconfig b/configs/xilinx_versal_mini_emmc1_defconfig
index 630f328e69ea..2c3775c3075b 100644
--- a/configs/xilinx_versal_mini_emmc1_defconfig
+++ b/configs/xilinx_versal_mini_emmc1_defconfig
@@ -31,6 +31,7 @@ CONFIG_CLOCKS=y
 CONFIG_SYS_PROMPT="Versal> "
 # CONFIG_CMD_BDI is not set
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/xilinx_versal_mini_ospi_defconfig b/configs/xilinx_versal_mini_ospi_defconfig
index cac691c92cee..11811f3c0fdb 100644
--- a/configs/xilinx_versal_mini_ospi_defconfig
+++ b/configs/xilinx_versal_mini_ospi_defconfig
@@ -31,6 +31,7 @@ CONFIG_BOARD_EARLY_INIT_R=y
 CONFIG_SYS_PROMPT="Versal> "
 # CONFIG_CMD_BDI is not set
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/xilinx_versal_mini_qspi_defconfig b/configs/xilinx_versal_mini_qspi_defconfig
index 220daa894ea0..47737ce0f8fd 100644
--- a/configs/xilinx_versal_mini_qspi_defconfig
+++ b/configs/xilinx_versal_mini_qspi_defconfig
@@ -32,6 +32,7 @@ CONFIG_SYS_PROMPT="Versal> "
 # CONFIG_SYS_XTRACE is not set
 # CONFIG_CMD_BDI is not set
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/xilinx_versal_net_mini_defconfig b/configs/xilinx_versal_net_mini_defconfig
index b0f4128932ce..27a163a9ae5c 100644
--- a/configs/xilinx_versal_net_mini_defconfig
+++ b/configs/xilinx_versal_net_mini_defconfig
@@ -33,6 +33,7 @@ CONFIG_BOARD_EARLY_INIT_R=y
 # CONFIG_SYS_LONGHELP is not set
 CONFIG_SYS_PROMPT="Versal NET> "
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/xilinx_versal_net_mini_emmc_defconfig b/configs/xilinx_versal_net_mini_emmc_defconfig
index 1f8fb162c976..8d3561fee6dc 100644
--- a/configs/xilinx_versal_net_mini_emmc_defconfig
+++ b/configs/xilinx_versal_net_mini_emmc_defconfig
@@ -26,6 +26,7 @@ CONFIG_BOARD_EARLY_INIT_R=y
 CONFIG_SYS_PROMPT="Versal NET> "
 # CONFIG_CMD_BDI is not set
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/xilinx_versal_net_mini_ospi_defconfig b/configs/xilinx_versal_net_mini_ospi_defconfig
index a8d0c5fc1287..aadfcfcf9dbf 100644
--- a/configs/xilinx_versal_net_mini_ospi_defconfig
+++ b/configs/xilinx_versal_net_mini_ospi_defconfig
@@ -30,6 +30,7 @@ CONFIG_BOARD_EARLY_INIT_R=y
 CONFIG_SYS_PROMPT="Versal NET> "
 # CONFIG_CMD_BDI is not set
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/xilinx_versal_net_mini_qspi_defconfig b/configs/xilinx_versal_net_mini_qspi_defconfig
index 1a3df99f65ed..ed4c3893315e 100644
--- a/configs/xilinx_versal_net_mini_qspi_defconfig
+++ b/configs/xilinx_versal_net_mini_qspi_defconfig
@@ -31,6 +31,7 @@ CONFIG_SYS_PROMPT="Versal NET> "
 # CONFIG_SYS_XTRACE is not set
 # CONFIG_CMD_BDI is not set
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/xilinx_zynqmp_mini_defconfig b/configs/xilinx_zynqmp_mini_defconfig
index a068e8976b48..41444271f0d9 100644
--- a/configs/xilinx_zynqmp_mini_defconfig
+++ b/configs/xilinx_zynqmp_mini_defconfig
@@ -27,6 +27,7 @@ CONFIG_CLOCKS=y
 # CONFIG_SYS_LONGHELP is not set
 # CONFIG_CMD_BDI is not set
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/xilinx_zynqmp_mini_emmc0_defconfig b/configs/xilinx_zynqmp_mini_emmc0_defconfig
index 498bd809afe8..369d480fd1ff 100644
--- a/configs/xilinx_zynqmp_mini_emmc0_defconfig
+++ b/configs/xilinx_zynqmp_mini_emmc0_defconfig
@@ -41,6 +41,7 @@ CONFIG_SPL_SYS_MALLOC_SIZE=0x1000000
 # CONFIG_AUTO_COMPLETE is not set
 # CONFIG_CMD_BDI is not set
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/xilinx_zynqmp_mini_emmc1_defconfig b/configs/xilinx_zynqmp_mini_emmc1_defconfig
index 6b053cfa3ada..2b415b8f7271 100644
--- a/configs/xilinx_zynqmp_mini_emmc1_defconfig
+++ b/configs/xilinx_zynqmp_mini_emmc1_defconfig
@@ -41,6 +41,7 @@ CONFIG_SPL_SYS_MALLOC_SIZE=0x1000000
 # CONFIG_AUTO_COMPLETE is not set
 # CONFIG_CMD_BDI is not set
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/xilinx_zynqmp_mini_nand_defconfig b/configs/xilinx_zynqmp_mini_nand_defconfig
index 09e0cfb693f6..c7271899bdf9 100644
--- a/configs/xilinx_zynqmp_mini_nand_defconfig
+++ b/configs/xilinx_zynqmp_mini_nand_defconfig
@@ -28,6 +28,7 @@ CONFIG_CLOCKS=y
 # CONFIG_SYS_LONGHELP is not set
 # CONFIG_CMD_BDI is not set
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/xilinx_zynqmp_mini_nand_single_defconfig b/configs/xilinx_zynqmp_mini_nand_single_defconfig
index e9258fa598f1..bb9cd8823403 100644
--- a/configs/xilinx_zynqmp_mini_nand_single_defconfig
+++ b/configs/xilinx_zynqmp_mini_nand_single_defconfig
@@ -28,6 +28,7 @@ CONFIG_CLOCKS=y
 # CONFIG_SYS_LONGHELP is not set
 # CONFIG_CMD_BDI is not set
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
diff --git a/configs/xilinx_zynqmp_mini_qspi_defconfig b/configs/xilinx_zynqmp_mini_qspi_defconfig
index 193cc7d27224..3f2d44d038e5 100644
--- a/configs/xilinx_zynqmp_mini_qspi_defconfig
+++ b/configs/xilinx_zynqmp_mini_qspi_defconfig
@@ -43,6 +43,7 @@ CONFIG_SPL_SYS_MALLOC_SIZE=0x1000000
 # CONFIG_SYS_LONGHELP is not set
 # CONFIG_CMD_BDI is not set
 # CONFIG_CMD_CONSOLE is not set
+# CONFIG_CMD_HELP is not set
 # CONFIG_CMD_BOOTD is not set
 # CONFIG_CMD_BOOTM is not set
 # CONFIG_CMD_BOOTI is not set
-- 
2.43.0

base-commit: 40ef75b0796307f718a4b424b5e52e79b36ae2f4

Re: [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@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@amd.com>
> Reviewed-by: Peter Robinson <pbrobinson@gmail.com>

Reviewed-by: Mattijs Korpershoek <mkorpershoek@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
>  
> +@pytest.mark.buildconfigspec('cmd_help')
>  def test_help(ubman):
>      """Test that the "help" command can be executed."""
>  
> -- 
> 2.43.0
>
> base-commit: 40ef75b0796307f718a4b424b5e52e79b36ae2f4

Re: [PATCH v2 1/2] cmd: Introduce CMD_HELP

[Michal Simek]

On 7/2/25 12:17, Mattijs Korpershoek wrote:
> Hi Michal,
> 
> Thank you for the patch.
> 
> On Mon, Jun 30, 2025 at 14:21, Michal Simek <michal.simek@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/

I fixed this directly and applied.

M