Skip to content

[Backport v3.7-branch] shell: shell_help: fix terminal offset of subcommands' help text #77643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Parent: V3.7 branch
merged 2 commits into from
Nov 5, 2024
Merged

[Backport v3.7-branch] shell: shell_help: fix terminal offset of subcommands' help text #77643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31dd0a0
shell: devmem: minor optimizations
ycsin Aug 23, 2024
6d9764e
shell: shell_help: fix width for subcommands help text
ycsin Aug 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions subsys/shell/modules/devmem_service.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,10 +315,6 @@ static int cmd_devmem(const struct shell *sh, size_t argc, char **argv)
uint32_t value = 0;
uint8_t width;

if (argc < 2 || argc > 4) {
return -EINVAL;
}

phys_addr = strtoul(argv[1], NULL, 16);

#if defined(CONFIG_MMU) || defined(CONFIG_PCIE)
Expand Down Expand Up @@ -365,11 +361,11 @@ SHELL_STATIC_SUBCMD_SET_CREATE(sub_devmem,
cmd_load, 2, 1),
SHELL_SUBCMD_SET_END);

SHELL_CMD_REGISTER(devmem, &sub_devmem,
SHELL_CMD_ARG_REGISTER(devmem, &sub_devmem,
"Read/write physical memory\n"
"Usage:\n"
"Read memory at address with optional width:\n"
"devmem address [width]\n"
"devmem <address> [<width>]\n"
"Write memory at address with mandatory width and value:\n"
"devmem address <width> <value>",
cmd_devmem);
"devmem <address> <width> <value>",
cmd_devmem, 2, 2);
3 changes: 2 additions & 1 deletion subsys/shell/shell_help.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Loading