docs/sched: Make the sched-stats documentation consistent
authorSwapnil Sapkal <swapnil.sapkal@amd.com>
Wed, 30 Apr 2025 06:25:59 +0000 (06:25 +0000)
committerJonathan Corbet <corbet@lwn.net>
Mon, 9 Jun 2025 22:23:58 +0000 (16:23 -0600)
commitd3f825032091fc14c7d5e34bcd54317ae4246903
treef609436683b4f56905d52ebdc734fc9e425e468e
parent112fe8c2f8daa7b4a691d5f8a64923ccc9093ce8
docs/sched: Make the sched-stats documentation consistent

pull_task(), the original function to move the task from src_rq to the
dst_rq during load balancing was renamed to move_tasks() in commit
ddcdf6e7d991 ("sched: Rename load-balancing fields")

As a part of commit 163122b7fcfa ("sched/fair: Remove
double_lock_balance() from load_balance()"), move_task() was broken down
into detach_tasks() and attach_tasks() pair to avoid holding locks of
both src_rq and dst_rq at the same time during load balancing.

Despite the evolution of pull_task() over the years, the sched-stats
documentation remained unchanged. Update the documentation to refer to
detach_task() instead of pull_task() which is responsible for removing
the task from the src_rq during load balancing.

commit 1c055a0f5d3b ("sched: Move sched domain name out of
CONFIG_SCHED_DEBUG") moves sched domain name out of CONFIG_SCHED_DEBUG.
Update the documentation related to that.

Reviewed-by: K Prateek Nayak <kprateek.nayak@amd.com>
Suggested-by: Shrikanth Hegde <sshegde@linux.ibm.com>
Signed-off-by: Swapnil Sapkal <swapnil.sapkal@amd.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250430062559.1188661-1-swapnil.sapkal@amd.com
Documentation/scheduler/sched-stats.rst