Commit 59a74b15 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Ingo Molnar
Browse files

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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarPeter Zijlstra (Intel) <peterz@infradead.org>
Signed-off-by: default avatarIngo Molnar <mingo@kernel.org>
Reviewed-by: default avatarVincent Guittot <vincent.guittot@linaro.org>
Link: https://lkml.kernel.org/r/50cd6f460aeb872ebe518a8e9cfffda2df8bdb0a.1606823973.git.mchehab+huawei@kernel.org
parent 3149cd55

kernel/sched/core.c

+8 −8
Original line number Diff line number Diff line
@@ -6611,14 +6611,6 @@ SYSCALL_DEFINE3(sched_getaffinity, pid_t, pid, unsigned int, len, 
	return ret;

}



/**

 * sys_sched_yield - yield the current processor to other threads.

 *

 * This function yields the current CPU to other tasks. If there are no

 * other threads running on this CPU then this function will return.

 *

 * Return: 0.

 */

static void do_sched_yield(void)

{

	struct rq_flags rf;
@@ -6636,6 +6628,14 @@ static void do_sched_yield(void) 
	schedule();

}



/**

 * sys_sched_yield - yield the current processor to other threads.

 *

 * This function yields the current CPU to other tasks. If there are no

 * other threads running on this CPU then this function will return.

 *

 * Return: 0.

 */

SYSCALL_DEFINE0(sched_yield)

{

	do_sched_yield();

kernel/sched/fair.c

+1 −1
Original line number Diff line number Diff line
@@ -6330,7 +6330,7 @@ static int select_idle_sibling(struct task_struct *p, int prev, int target) 
}



/**

 * Amount of capacity of a CPU that is (estimated to be) used by CFS tasks

 * cpu_util - Estimates the amount of capacity of a CPU used by CFS tasks.

 * @cpu: the CPU to get the utilization of

 *

 * The unit of the return value must be the one of capacity so we can compare