Skip to contentSkip to conversation

tools/rtla: Fix --dump-task option name to --dump-tasks

PATCH In review Costa Shulyupin 2 participants 3 messages Apr 14

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 tools/rtla: Fix --dump-task option name to --dump-tasks

The option was inconsistently named --dump-task in the usage string and getopt_long table while the actual implementation uses --dump-tasks. Fix both occurrences to match.

Assisted-by Claude:claude-opus-4-6
---
 tools/tracing/rtla/src/timerlat_hist.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
tools/tracing/rtla/src/timerlat_hist.c +2 -2
index 79142af4f566..3a15a85b7d72 100644
@@ -694,7 +694,7 @@ static void timerlat_hist_usage(void)
 		"[-d s] [-D] [-n] [-a us] [-p us] [-i us] [-T us] [-s us] \\",
 		"         [-t [file]] [-e sys[:event]] [--filter <filter>] [--trigger <trigger>] [-c cpu-list] [-H cpu-list]\\",
 		"	  [-P priority] [-E N] [-b N] [--no-irq] [--no-thread] [--no-header] [--no-summary] \\",
-		"	  [--no-index] [--with-zeros] [--dma-latency us] [-C [cgroup_name]] [--no-aa] [--dump-task] [-u|-k]",
+		"	  [--no-index] [--with-zeros] [--dma-latency us] [-C [cgroup_name]] [--no-aa] [--dump-tasks] [-u|-k]",
 		"	  [--warm-up s] [--deepest-idle-state n]",
 		NULL,
 	};
@@ -808,7 +808,7 @@ static struct common_params
 			{"filter",		required_argument,	0, '7'},
 			{"dma-latency",		required_argument,	0, '8'},
 			{"no-aa",		no_argument,		0, '9'},
-			{"dump-task",		no_argument,		0, '\1'},
+			{"dump-tasks",		no_argument,		0, '\1'},
 			{"warm-up",		required_argument,	0, '\2'},
 			{"trace-buffer-size",	required_argument,	0, '\3'},
 			{"deepest-idle-state",	required_argument,	0, '\4'},
Signature · 1 line
2.53.0
#1 lore raw
Quoted 3 lines · Costa Shulyupin

The option was inconsistently named --dump-task in the usage string and getopt_long table while the actual implementation uses --dump-tasks. Fix both occurrences to match.

How is the getopt_long table not the "actual implementation"?

Wouldn't it make more sense to fix the one place in the documentation that says --dump-tasks to match what the current behavior is?

...except that apparently timerlat top does use --dump-tasks[1], so maybe we want to make that consistent, but the changelog should be clear that this is an interface change for timerlat hist.

We should also probably be making sure we have test coverage for both hist and top, which would have caught this, rather than picking one or the other for most tests.

-Crystal

[1] Oddly, timerlat_top.c is missing --dump-tasks from msg_start[], which is the one place that timerlat_hist.c has the plural --dump-tasks.

#2 lore raw
Quoted 1 line

How is the getopt_long table not the "actual implementation"?

You are right. My bad.

Costa