2023-12-01 09:27:19

by Anna-Maria Behnsen

[permalink] [raw]
Subject: [PATCH v9 01/32] tick-sched: Fix function names in comments

When referencing functions in comments, it might be helpful to use full
function names (including the prefix) to be able to find it when grepping.

Signed-off-by: Anna-Maria Behnsen <[email protected]>
---
v9: New cleanup patch
---
kernel/time/tick-sched.c | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/kernel/time/tick-sched.c b/kernel/time/tick-sched.c
index be77b021e5d6..5c28cc80fd25 100644
--- a/kernel/time/tick-sched.c
+++ b/kernel/time/tick-sched.c
@@ -920,11 +920,11 @@ static void tick_nohz_stop_tick(struct tick_sched *ts, int cpu)
}

/*
- * nohz_stop_sched_tick() can be called several times before
- * nohz_restart_sched_tick() is called. This happens when
- * interrupts arrive which do not cause a reschedule. In the
- * first call we save the current tick time, so we can restart
- * the scheduler tick in nohz_restart_sched_tick().
+ * tick_nohz_stop_sched_tick() can be called several times before
+ * tick_nohz_restart_sched_tick() is called. This happens when
+ * interrupts arrive which do not cause a reschedule. In the first call
+ * we save the current tick time, so we can restart the scheduler tick
+ * in tick_nohz_restart_sched_tick().
*/
if (!ts->tick_stopped) {
calc_load_nohz_start();
--
2.39.2


2023-12-20 13:09:18

by Frederic Weisbecker

[permalink] [raw]
Subject: Re: [PATCH v9 01/32] tick-sched: Fix function names in comments

Le Fri, Dec 01, 2023 at 10:26:23AM +0100, Anna-Maria Behnsen a ?crit :
> When referencing functions in comments, it might be helpful to use full
> function names (including the prefix) to be able to find it when grepping.
>
> Signed-off-by: Anna-Maria Behnsen <[email protected]>

Reviewed-by: Frederic Weisbecker <[email protected]>

Just a small detail that be addressed as a further patch (or edited
while applying).

> ---
> v9: New cleanup patch
> ---
> kernel/time/tick-sched.c | 10 +++++-----
> 1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/kernel/time/tick-sched.c b/kernel/time/tick-sched.c
> index be77b021e5d6..5c28cc80fd25 100644
> --- a/kernel/time/tick-sched.c
> +++ b/kernel/time/tick-sched.c
> @@ -920,11 +920,11 @@ static void tick_nohz_stop_tick(struct tick_sched *ts, int cpu)
> }
>
> /*
> - * nohz_stop_sched_tick() can be called several times before
> - * nohz_restart_sched_tick() is called. This happens when
> - * interrupts arrive which do not cause a reschedule. In the
> - * first call we save the current tick time, so we can restart
> - * the scheduler tick in nohz_restart_sched_tick().
> + * tick_nohz_stop_sched_tick() can be called several times before

s/tick_nohz_stop_sched_tick/tick_nohz_stop_tick

Because in the case of nohz_full it's indeed true. But idle behaves the same
even though it uses another function (tick_nohz_idle_stop_tick()).

More generally tick_nohz_stop_tick() covers both idle and nohz_full case
and behaves as described.

I guess at some point we should rename tick_nohz_stop_sched_tick() to
tick_nohz_full_stop_tick() to avoid such confusion.

Thanks.

> + * tick_nohz_restart_sched_tick() is called. This happens when
> + * interrupts arrive which do not cause a reschedule. In the first call
> + * we save the current tick time, so we can restart the scheduler tick
> + * in tick_nohz_restart_sched_tick().
> */
> if (!ts->tick_stopped) {
> calc_load_nohz_start();
> --
> 2.39.2
>

2023-12-20 16:10:21

by tip-bot2 for Jacob Pan

[permalink] [raw]
Subject: [tip: timers/core] tick-sched: Fix function names in comments

The following commit has been merged into the timers/core branch of tip:

Commit-ID: cb665db94fc61512c9c94ed1d42af67e7bf6ce01
Gitweb: https://git.kernel.org/tip/cb665db94fc61512c9c94ed1d42af67e7bf6ce01
Author: Anna-Maria Behnsen <[email protected]>
AuthorDate: Fri, 01 Dec 2023 10:26:23 +01:00
Committer: Thomas Gleixner <[email protected]>
CommitterDate: Wed, 20 Dec 2023 16:49:37 +01:00

tick-sched: Fix function names in comments

When referencing functions in comments, it might be helpful to use full
function names (including the prefix) to be able to find it when grepping.

Signed-off-by: Anna-Maria Behnsen <[email protected]>
Signed-off-by: Thomas Gleixner <[email protected]>
Reviewed-by: Frederic Weisbecker <[email protected]>
Link: https://lore.kernel.org/r/[email protected]

---
kernel/time/tick-sched.c | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/kernel/time/tick-sched.c b/kernel/time/tick-sched.c
index be77b02..ff25fdf 100644
--- a/kernel/time/tick-sched.c
+++ b/kernel/time/tick-sched.c
@@ -920,11 +920,11 @@ static void tick_nohz_stop_tick(struct tick_sched *ts, int cpu)
}

/*
- * nohz_stop_sched_tick() can be called several times before
- * nohz_restart_sched_tick() is called. This happens when
- * interrupts arrive which do not cause a reschedule. In the
- * first call we save the current tick time, so we can restart
- * the scheduler tick in nohz_restart_sched_tick().
+ * tick_nohz_stop_tick() can be called several times before
+ * tick_nohz_restart_sched_tick() is called. This happens when
+ * interrupts arrive which do not cause a reschedule. In the first
+ * call we save the current tick time, so we can restart the
+ * scheduler tick in tick_nohz_restart_sched_tick().
*/
if (!ts->tick_stopped) {
calc_load_nohz_start();