diff mbox series

syscalls/sched_rr_get_interval: Convert to docparse

Message ID 20231031132756.12799-1-chrubis@suse.cz
State Accepted
Headers show
Series syscalls/sched_rr_get_interval: Convert to docparse | expand

Commit Message

Cyril Hrubis Oct. 31, 2023, 1:27 p.m. UTC
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(-)

Comments

Cyril Hrubis Dec. 8, 2023, 3:21 p.m. UTC | #1
Hi!
Ping?
Avinesh Kumar Dec. 11, 2023, 9:02 p.m. UTC | #2
Hi,

Reviewed-by: Avinesh Kumar <akumar@suse.de>


--
Regards,
Avinesh
Petr Vorel Dec. 15, 2023, 7:07 p.m. UTC | #3
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
Petr Vorel Jan. 4, 2024, 3:29 p.m. UTC | #4
Hi Cyril,

> Hi Cyril,
...
> 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:
I'm sorry, also I miss blank line before list. I need to write check for that.
>  * * 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")

But feel free to merge either in list in docparse or original version, but with
commits in plain /* */ (will not be in docparse.

Kind regards,
Petr

>  */

> 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
Cyril Hrubis Jan. 10, 2024, 11:29 a.m. UTC | #5
Hi!
> 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")
>  */
>
> Reviewed-by: Petr Vorel <pvorel@suse.cz>

I've changed the this as proposed (added empty line and used '-' instead
of '*' though) and pushed, thanks.
diff mbox series

Patch

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
  */
 
 #include "time64_variants.h"
diff --git a/testcases/kernel/syscalls/sched_rr_get_interval/sched_rr_get_interval02.c b/testcases/kernel/syscalls/sched_rr_get_interval/sched_rr_get_interval02.c
index 15e4a3053..a61e2969b 100644
--- a/testcases/kernel/syscalls/sched_rr_get_interval/sched_rr_get_interval02.c
+++ b/testcases/kernel/syscalls/sched_rr_get_interval/sched_rr_get_interval02.c
@@ -2,6 +2,9 @@ 
 /*
  * Copyright (c) Wipro Technologies Ltd, 2002.  All Rights Reserved.
  *    AUTHOR		: Saji Kumar.V.R <saji.kumar@wipro.com>
+ */
+/*\
+ * [Description]
  *
  * Verify that for a process with scheduling policy SCHED_FIFO,
  * sched_rr_get_interval() writes zero into timespec structure
diff --git a/testcases/kernel/syscalls/sched_rr_get_interval/sched_rr_get_interval03.c b/testcases/kernel/syscalls/sched_rr_get_interval/sched_rr_get_interval03.c
index f5a88f084..731c50082 100644
--- a/testcases/kernel/syscalls/sched_rr_get_interval/sched_rr_get_interval03.c
+++ b/testcases/kernel/syscalls/sched_rr_get_interval/sched_rr_get_interval03.c
@@ -2,14 +2,20 @@ 
 /*
  * Copyright (c) Wipro Technologies Ltd, 2002.  All Rights Reserved.
  *    AUTHOR		: Saji Kumar.V.R <saji.kumar@wipro.com>
+ */
+/*\
+ * [Description]
+ *
+ * Verify that:
+ *
+ * - sched_rr_get_interval() fails with errno set to EINVAL for an
+ *   invalid pid
+ *
+ * - sched_rr_get_interval() fails with errno set to ESRCH if the
+ *   process with specified pid does not exists
  *
- * Verify that
- *  1) sched_rr_get_interval() fails with errno set to EINVAL for an
- *     invalid pid
- *  2) sched_rr_get_interval() fails with errno set to ESRCH if the
- *     process with specified pid does not exists
- *  3) sched_rr_get_interval() fails with errno set to EFAULT if the
- *     address specified as &tp is invalid
+ * - sched_rr_get_interval() fails with errno set to EFAULT if the
+ *   address specified as &tp is invalid
  */
 
 #include "time64_variants.h"