[PATCH] docs/scheduler: Fix busy and idle type ordering

Adam Li posted 1 patch 1 year ago
Documentation/scheduler/sched-stats.rst | 34 ++++++++++++-------------
1 file changed, 17 insertions(+), 17 deletions(-)
[PATCH] docs/scheduler: Fix busy and idle type ordering
Posted by Adam Li 1 year ago
Commit 11b0bfa5d463 ("sched/debug: Increase SCHEDSTAT_VERSION to 16")
documented change of CPU_IDLE and __CPU_NOT_IDLE ordering in
'enum cpu_idle_type'.

Fix the domain statistics description due to the ordering change.

Signed-off-by: Adam Li <adamli@os.amperecomputing.com>
---
 Documentation/scheduler/sched-stats.rst | 34 ++++++++++++-------------
 1 file changed, 17 insertions(+), 17 deletions(-)

diff --git a/Documentation/scheduler/sched-stats.rst b/Documentation/scheduler/sched-stats.rst
index 7c2b16c4729d..ab6f5392910d 100644
--- a/Documentation/scheduler/sched-stats.rst
+++ b/Documentation/scheduler/sched-stats.rst
@@ -78,39 +78,39 @@ domain<N> <cpumask> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 The first field is a bit mask indicating what cpus this domain operates over.
 
 The next 24 are a variety of sched_balance_rq() statistics in grouped into types
-of idleness (idle, busy, and newly idle):
+of idleness (busy, idle, and newly idle):
 
     1)  # of times in this domain sched_balance_rq() was called when the
-        cpu was idle
+        cpu was busy
     2)  # of times in this domain sched_balance_rq() checked but found
-        the load did not require balancing when the cpu was idle
+        the load did not require balancing when the cpu was busy
     3)  # of times in this domain sched_balance_rq() tried to move one or
-        more tasks and failed, when the cpu was idle
+        more tasks and failed, when the cpu was busy
     4)  sum of imbalances discovered (if any) with each call to
-        sched_balance_rq() in this domain when the cpu was idle
+        sched_balance_rq() in this domain when the cpu was busy
     5)  # of times in this domain pull_task() was called when the cpu
-        was idle
+        was busy
     6)  # of times in this domain pull_task() was called even though
-        the target task was cache-hot when idle
+        the target task was cache-hot when busy
     7)  # of times in this domain sched_balance_rq() was called but did
-        not find a busier queue while the cpu was idle
+        not find a busier queue while the cpu was busy
     8)  # of times in this domain a busier queue was found while the
-        cpu was idle but no busier group was found
+        cpu was busy but no busier group was found
     9)  # of times in this domain sched_balance_rq() was called when the
-        cpu was busy
+        cpu was idle
     10) # of times in this domain sched_balance_rq() checked but found the
-        load did not require balancing when busy
+        load did not require balancing when idle
     11) # of times in this domain sched_balance_rq() tried to move one or
-        more tasks and failed, when the cpu was busy
+        more tasks and failed, when the cpu was idle
     12) sum of imbalances discovered (if any) with each call to
-        sched_balance_rq() in this domain when the cpu was busy
-    13) # of times in this domain pull_task() was called when busy
+        sched_balance_rq() in this domain when the cpu was idle
+    13) # of times in this domain pull_task() was called when idle
     14) # of times in this domain pull_task() was called even though the
-        target task was cache-hot when busy
+        target task was cache-hot when idle
     15) # of times in this domain sched_balance_rq() was called but did not
-        find a busier queue while the cpu was busy
+        find a busier queue while the cpu was idle
     16) # of times in this domain a busier queue was found while the cpu
-        was busy but no busier group was found
+        was idle but no busier group was found
 
     17) # of times in this domain sched_balance_rq() was called when the
         cpu was just becoming idle
-- 
2.25.1
Re: [PATCH] docs/scheduler: Fix busy and idle type ordering
Posted by Shrikanth Hegde 12 months ago

On 12/9/24 09:24, Adam Li wrote:
> Commit 11b0bfa5d463 ("sched/debug: Increase SCHEDSTAT_VERSION to 16")
> documented change of CPU_IDLE and __CPU_NOT_IDLE ordering in
> 'enum cpu_idle_type'.
> 
> Fix the domain statistics description due to the ordering change.
> 
> Signed-off-by: Adam Li <adamli@os.amperecomputing.com>

Looks fine to me.

Reviewed-by: Shrikanth Hegde <sshegde@linux.ibm.com>

> ---
>   Documentation/scheduler/sched-stats.rst | 34 ++++++++++++-------------
>   1 file changed, 17 insertions(+), 17 deletions(-)
> 
> diff --git a/Documentation/scheduler/sched-stats.rst b/Documentation/scheduler/sched-stats.rst
> index 7c2b16c4729d..ab6f5392910d 100644
> --- a/Documentation/scheduler/sched-stats.rst
> +++ b/Documentation/scheduler/sched-stats.rst
> @@ -78,39 +78,39 @@ domain<N> <cpumask> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
>   The first field is a bit mask indicating what cpus this domain operates over.
>   
>   The next 24 are a variety of sched_balance_rq() statistics in grouped into types
> -of idleness (idle, busy, and newly idle):
> +of idleness (busy, idle, and newly idle):
>   
>       1)  # of times in this domain sched_balance_rq() was called when the
> -        cpu was idle
> +        cpu was busy
>       2)  # of times in this domain sched_balance_rq() checked but found
> -        the load did not require balancing when the cpu was idle
> +        the load did not require balancing when the cpu was busy
>       3)  # of times in this domain sched_balance_rq() tried to move one or
> -        more tasks and failed, when the cpu was idle
> +        more tasks and failed, when the cpu was busy
>       4)  sum of imbalances discovered (if any) with each call to
> -        sched_balance_rq() in this domain when the cpu was idle
> +        sched_balance_rq() in this domain when the cpu was busy
>       5)  # of times in this domain pull_task() was called when the cpu
> -        was idle
> +        was busy
>       6)  # of times in this domain pull_task() was called even though
> -        the target task was cache-hot when idle
> +        the target task was cache-hot when busy
>       7)  # of times in this domain sched_balance_rq() was called but did
> -        not find a busier queue while the cpu was idle
> +        not find a busier queue while the cpu was busy
>       8)  # of times in this domain a busier queue was found while the
> -        cpu was idle but no busier group was found
> +        cpu was busy but no busier group was found
>       9)  # of times in this domain sched_balance_rq() was called when the
> -        cpu was busy
> +        cpu was idle
>       10) # of times in this domain sched_balance_rq() checked but found the
> -        load did not require balancing when busy
> +        load did not require balancing when idle
>       11) # of times in this domain sched_balance_rq() tried to move one or
> -        more tasks and failed, when the cpu was busy
> +        more tasks and failed, when the cpu was idle
>       12) sum of imbalances discovered (if any) with each call to
> -        sched_balance_rq() in this domain when the cpu was busy
> -    13) # of times in this domain pull_task() was called when busy
> +        sched_balance_rq() in this domain when the cpu was idle
> +    13) # of times in this domain pull_task() was called when idle
>       14) # of times in this domain pull_task() was called even though the
> -        target task was cache-hot when busy
> +        target task was cache-hot when idle
>       15) # of times in this domain sched_balance_rq() was called but did not
> -        find a busier queue while the cpu was busy
> +        find a busier queue while the cpu was idle
>       16) # of times in this domain a busier queue was found while the cpu
> -        was busy but no busier group was found
> +        was idle but no busier group was found
>   
>       17) # of times in this domain sched_balance_rq() was called when the
>           cpu was just becoming idle