Re: [LTP] [PATCH] syscalls/sched_rr_get_interval: Convert to docparse

Petr Vorel
2023-12-15T19:07:43Z

Hi Cyril,

> Signed-off-by: Cyril Hrubis <chrubis@suse.cz>
> ---
> .../sched_rr_get_interval01.c | 19 +++++++++++++++---
> .../sched_rr_get_interval02.c | 3 +++
> .../sched_rr_get_interval03.c | 20 ++++++++++++-------
> 3 files changed, 32 insertions(+), 10 deletions(-)

> diff --git a/testcases/kernel/syscalls/sched_rr_get_interval/sched_rr_get_interval01.c b/testcases/kernel/syscalls/sched_rr_get_interval/sched_rr_get_interval01.c
> index 597de4665..520f44fe0 100644
> --- a/testcases/kernel/syscalls/sched_rr_get_interval/sched_rr_get_interval01.c
> +++ b/testcases/kernel/syscalls/sched_rr_get_interval/sched_rr_get_interval01.c
> @@ -2,13 +2,26 @@
> /*
> * Copyright (c) Wipro Technologies Ltd, 2002. All Rights Reserved.
> * AUTHOR : Saji Kumar.V.R <saji.kumar@wipro.com>
> + */
> +/*\
> + * [Description]
> *
> * Gets round-robin time quantum by calling sched_rr_get_interval() and
> * checks that the value is sane.
> *
> - * It is also a regression test for kernel
> - * commit 975e155ed873 ("sched/rt: Show the 'sched_rr_timeslice' SCHED_RR
> - * timeslice tuning knob in milliseconds").
> + * It is also a regression test for:
> + *
> + * commit 975e155ed8732cb81f55c021c441ae662dd040b5
> + * Author: Shile Zhang <shile.zhang@nokia.com>
> + * Date: Sat Jan 28 22:00:49 2017 +0800
> + *
> + * sched/rt: Show the 'sched_rr_timeslice' SCHED_RR timeslice tuning knob in milliseconds
> + *
> + * commit c7fcb99877f9f542c918509b2801065adcaf46fa
> + * Author: Cyril Hrubis <chrubis@suse.cz>
> + * Date: Wed Aug 2 17:19:05 2023 +0200
> + *
> + * sched/rt: Fix sysctl_sched_rr_timeslice intial value

I was going to merge, but this is really ugly formatting in html.

If the dates and authors are important, could this comment be inside normal
comments (e.g. info is in the sources, but not in docparse doc)? Because we have
that info in docs as linux-git tags.

Or, if this is not important, could we use just:

/*\
* [Description]
....
* It is also a regression test for:
* * 975e155ed8732 ("sched/rt: Show the 'sched_rr_timeslice' SCHED_RR timeslice tuning knob in milliseconds")
* * c7fcb99877f9f ("sched/rt: Fix sysctl_sched_rr_timeslice intial value")
*/

Also, for me would be instead of year enough just to add also kernel release to the hash.

Reviewed-by: Petr Vorel <pvorel@suse.cz>

Kind regards,
Petr