Skip to content

Commit 59a74b1

Browse files
mchehabingomolnar
authored andcommitted
sched: Fix kernel-doc markup
Kernel-doc requires that a kernel-doc markup to be immediately below the function prototype, as otherwise it will rename it. So, move sys_sched_yield() markup to the right place. Also fix the cpu_util() markup: Kernel-doc markups should use this format: identifier - description Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org> Signed-off-by: Ingo Molnar <mingo@kernel.org> Reviewed-by: Vincent Guittot <vincent.guittot@linaro.org> Link: https://lkml.kernel.org/r/50cd6f460aeb872ebe518a8e9cfffda2df8bdb0a.1606823973.git.mchehab+huawei@kernel.org
1 parent 3149cd5 commit 59a74b1

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

kernel/sched/core.c

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6611,14 +6611,6 @@ SYSCALL_DEFINE3(sched_getaffinity, pid_t, pid, unsigned int, len,
66116611
return ret;
66126612
}
66136613

6614-
/**
6615-
* sys_sched_yield - yield the current processor to other threads.
6616-
*
6617-
* This function yields the current CPU to other tasks. If there are no
6618-
* other threads running on this CPU then this function will return.
6619-
*
6620-
* Return: 0.
6621-
*/
66226614
static void do_sched_yield(void)
66236615
{
66246616
struct rq_flags rf;
@@ -6636,6 +6628,14 @@ static void do_sched_yield(void)
66366628
schedule();
66376629
}
66386630

6631+
/**
6632+
* sys_sched_yield - yield the current processor to other threads.
6633+
*
6634+
* This function yields the current CPU to other tasks. If there are no
6635+
* other threads running on this CPU then this function will return.
6636+
*
6637+
* Return: 0.
6638+
*/
66396639
SYSCALL_DEFINE0(sched_yield)
66406640
{
66416641
do_sched_yield();

kernel/sched/fair.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6330,7 +6330,7 @@ static int select_idle_sibling(struct task_struct *p, int prev, int target)
63306330
}
63316331

63326332
/**
6333-
* Amount of capacity of a CPU that is (estimated to be) used by CFS tasks
6333+
* cpu_util - Estimates the amount of capacity of a CPU used by CFS tasks.
63346334
* @cpu: the CPU to get the utilization of
63356335
*
63366336
* The unit of the return value must be the one of capacity so we can compare

0 commit comments

Comments
 (0)