* [PATCH] tracing/timer: Add missing argument documentation of trace points
@ 2022-04-11 14:01 Anna-Maria Behnsen
2022-04-11 21:59 ` Steven Rostedt
2022-04-14 14:21 ` [tip: timers/core] " tip-bot2 for Anna-Maria Behnsen
0 siblings, 2 replies; 3+ messages in thread
From: Anna-Maria Behnsen @ 2022-04-11 14:01 UTC (permalink / raw)
To: linux-kernel; +Cc: Thomas Gleixner, Steven Rostedt, Ingo Molnar
Documentation of trace points timer_start, timer_expire_entry and
hrtimer_start lack always the last argument. Add it to keep implementation
and documentation in sync.
Signed-off-by: Anna-Maria Behnsen <anna-maria@linutronix.de>
---
include/trace/events/timer.h | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/include/trace/events/timer.h b/include/trace/events/timer.h
index 6ad031c71be7..2e713a7d9aa3 100644
--- a/include/trace/events/timer.h
+++ b/include/trace/events/timer.h
@@ -48,6 +48,7 @@ DEFINE_EVENT(timer_class, timer_init,
* timer_start - called when the timer is started
* @timer: pointer to struct timer_list
* @expires: the timers expiry time
+ * @flags: the timers flags
*/
TRACE_EVENT(timer_start,
@@ -84,6 +85,7 @@ TRACE_EVENT(timer_start,
/**
* timer_expire_entry - called immediately before the timer callback
* @timer: pointer to struct timer_list
+ * @baseclk: value of timer_base::clk when timer expires
*
* Allows to determine the timer latency.
*/
@@ -190,7 +192,8 @@ TRACE_EVENT(hrtimer_init,
/**
* hrtimer_start - called when the hrtimer is started
- * @hrtimer: pointer to struct hrtimer
+ * @hrtimer: pointer to struct hrtimer
+ * @mode: the hrtimers mode
*/
TRACE_EVENT(hrtimer_start,
--
2.20.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] tracing/timer: Add missing argument documentation of trace points
2022-04-11 14:01 [PATCH] tracing/timer: Add missing argument documentation of trace points Anna-Maria Behnsen
@ 2022-04-11 21:59 ` Steven Rostedt
2022-04-14 14:21 ` [tip: timers/core] " tip-bot2 for Anna-Maria Behnsen
1 sibling, 0 replies; 3+ messages in thread
From: Steven Rostedt @ 2022-04-11 21:59 UTC (permalink / raw)
To: Anna-Maria Behnsen; +Cc: linux-kernel, Thomas Gleixner, Ingo Molnar
On Mon, 11 Apr 2022 16:01:15 +0200
Anna-Maria Behnsen <anna-maria@linutronix.de> wrote:
> Documentation of trace points timer_start, timer_expire_entry and
> hrtimer_start lack always the last argument. Add it to keep implementation
> and documentation in sync.
>
> Signed-off-by: Anna-Maria Behnsen <anna-maria@linutronix.de>
Looks fine to me. I expect this to go through the timer tree?
Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>
-- Steve
^ permalink raw reply [flat|nested] 3+ messages in thread
* [tip: timers/core] tracing/timer: Add missing argument documentation of trace points
2022-04-11 14:01 [PATCH] tracing/timer: Add missing argument documentation of trace points Anna-Maria Behnsen
2022-04-11 21:59 ` Steven Rostedt
@ 2022-04-14 14:21 ` tip-bot2 for Anna-Maria Behnsen
1 sibling, 0 replies; 3+ messages in thread
From: tip-bot2 for Anna-Maria Behnsen @ 2022-04-14 14:21 UTC (permalink / raw)
To: linux-tip-commits
Cc: Anna-Maria Behnsen, Thomas Gleixner, Steven Rostedt (Google),
x86, linux-kernel
The following commit has been merged into the timers/core branch of tip:
Commit-ID: fde33ca4cb2bae6472714123b451475fdfd9995c
Gitweb: https://git.kernel.org/tip/fde33ca4cb2bae6472714123b451475fdfd9995c
Author: Anna-Maria Behnsen <anna-maria@linutronix.de>
AuthorDate: Mon, 11 Apr 2022 16:01:15 +02:00
Committer: Thomas Gleixner <tglx@linutronix.de>
CommitterDate: Thu, 14 Apr 2022 16:14:49 +02:00
tracing/timer: Add missing argument documentation of trace points
Documentation of trace points timer_start, timer_expire_entry and
hrtimer_start lack always the last argument. Add it to keep implementation
and documentation in sync.
Signed-off-by: Anna-Maria Behnsen <anna-maria@linutronix.de>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>
Link: https://lore.kernel.org/r/20220411140115.24185-1-anna-maria@linutronix.de
---
include/trace/events/timer.h | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/include/trace/events/timer.h b/include/trace/events/timer.h
index 6ad031c..2e713a7 100644
--- a/include/trace/events/timer.h
+++ b/include/trace/events/timer.h
@@ -48,6 +48,7 @@ DEFINE_EVENT(timer_class, timer_init,
* timer_start - called when the timer is started
* @timer: pointer to struct timer_list
* @expires: the timers expiry time
+ * @flags: the timers flags
*/
TRACE_EVENT(timer_start,
@@ -84,6 +85,7 @@ TRACE_EVENT(timer_start,
/**
* timer_expire_entry - called immediately before the timer callback
* @timer: pointer to struct timer_list
+ * @baseclk: value of timer_base::clk when timer expires
*
* Allows to determine the timer latency.
*/
@@ -190,7 +192,8 @@ TRACE_EVENT(hrtimer_init,
/**
* hrtimer_start - called when the hrtimer is started
- * @hrtimer: pointer to struct hrtimer
+ * @hrtimer: pointer to struct hrtimer
+ * @mode: the hrtimers mode
*/
TRACE_EVENT(hrtimer_start,
^ permalink raw reply related [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-04-14 15:40 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-04-11 14:01 [PATCH] tracing/timer: Add missing argument documentation of trace points Anna-Maria Behnsen
2022-04-11 21:59 ` Steven Rostedt
2022-04-14 14:21 ` [tip: timers/core] " tip-bot2 for Anna-Maria Behnsen
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).