shell: shell_help: fix width for subcommands help text

ycsin · nashif · commit 422657bc7fd8 · 2024-11-05T10:53:22.000-05:00
The terminal offset for subcommands' help text isn't computed correctly, fix it. Signed-off-by: Yong Cong Sin <ycsin@meta.com> Signed-off-by: Yong Cong Sin <yongcong.sin@gmail.com> (cherry picked from commit fd1be98)
diff --git a/subsys/shell/shell_help.c b/subsys/shell/shell_help.c
@@ -110,7 +110,8 @@ static void help_item_print(const struct shell *sh, const char *item_name,
 			    uint16_t item_name_width, const char *item_help)
 {
 	static const uint8_t tabulator[] = "  ";
-	const uint16_t offset = 2 * strlen(tabulator) + item_name_width + 1;
+	static const char sub_cmd_sep[] = ": "; /* subcommands separator */
+	const uint16_t offset = 2 * strlen(tabulator) + item_name_width + strlen(sub_cmd_sep);
 
 	if ((item_name == NULL) || (item_name[0] == '\0')) {
 		return;

Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,8 @@ static void help_item_print(const struct shell sh, const char item_name,`
`110`	`110`	`uint16_t item_name_width, const char *item_help)`
`111`	`111`	`{`
`112`	`112`	`static const uint8_t tabulator[] = " ";`
`113`		`- const uint16_t offset = 2 * strlen(tabulator) + item_name_width + 1;`
	`113`	`+ static const char sub_cmd_sep[] = ": "; /* subcommands separator */`
	`114`	`+ const uint16_t offset = 2 * strlen(tabulator) + item_name_width + strlen(sub_cmd_sep);`
`114`	`115`
`115`	`116`	`if ((item_name == NULL) \|\| (item_name[0] == '\0')) {`
`116`	`117`	`return;`