[PATCH v3 53/56] shed: fix kernel-doc markup

Mauro Carvalho Chehab
2020-10-23T16:35:10Z

Kernel-doc requires that a kernel-doc markup to be immediatly
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>
---
kernel/sched/core.c | 16 ++++++++--------
kernel/sched/fair.c | 3 ++-
2 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/kernel/sched/core.c b/kernel/sched/core.c
index 8160ab5263f8..f7189247f007 100644
--- a/kernel/sched/core.c
+++ b/kernel/sched/core.c
@@ -6076,14 +6076,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;
@@ -6105,6 +6097,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();
diff --git a/kernel/sched/fair.c b/kernel/sched/fair.c
index aa4c6227cd6d..94386fcfafcf 100644
--- a/kernel/sched/fair.c
+++ b/kernel/sched/fair.c
@@ -6287,7 +6287,8 @@ 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 - Amount of capacity of a CPU that is (estimated to be)
+ * 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
--
2.26.2