Skip to contentSkip to conversation

sched: fix missing kernel-doc notation

PATCH In review Randy Dunlap 1 participant 2 messages Oct 12, 2009

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 sched: fix missing kernel-doc notation

Subject: [PATCH] sched: fix htmldocs sched.c
From: Jaswinder Singh Rajput <[email protected]>
Date: Thu, 24 Sep 2009 19:08:50 +0530

fix the following htmldocs warnings:

Warning(kernel/sched.c:685): No description found for parameter 'cpu' Warning(kernel/sched.c:3676): No description found for parameter 'sd'

Cc Andrew Morton <[email protected]>
Cc Steven Rostedt <[email protected]>
Cc Peter Zijlstra <[email protected]>
Cc Ingo Molnar <[email protected]>
---
 kernel/sched.c |    2 ++
 1 files changed, 2 insertions(+), 0 deletions(-)
kernel/sched.c +2 -0
index 2f76e06..f0d1375 100644
@@ -676,6 +676,7 @@ inline void update_rq_clock(struct rq *rq)
 
 /**
  * runqueue_is_locked
+ * @cpu: the processor in question.
  *
  * Returns true if the current cpu runqueue is locked.
  * This interface allows printk to be called with the runqueue lock
@@ -3658,6 +3659,7 @@ static void update_group_power(struct sched_domain *sd, int cpu)
 
 /**
  * update_sg_lb_stats - Update sched_group's statistics for load balancing.
+ * @sd: The sched_domain whose statistics are to be updated.
  * @group: sched_group whose statistics are to be updated.
  * @this_cpu: Cpu for which load balance is currently performed.
  * @idle: Idle status of this_cpu

---

#1 lore raw

[tip:sched/urgent] sched: Fix missing kernel-doc notation

Commit-ID:  e17b38bf9e70d74f3739a600db75240078ac1407
Gitweb:     http://git.kernel.org/tip/e17b38bf9e70d74f3739a600db75240078ac1407
Author:     Randy Dunlap <[email protected]>
AuthorDate: Sun, 11 Oct 2009 19:12:00 -0700
Committer:  Ingo Molnar <[email protected]>
CommitDate: Mon, 12 Oct 2009 10:50:06 +0200

sched: Fix missing kernel-doc notation

The following htmldocs warnings:

Warning(kernel/sched.c:685): No description found for parameter 'cpu' Warning(kernel/sched.c:3676): No description found for parameter 'sd'

Trigger because new parameters were added to update_rq_clock() and update_group_power() without updating the kernel-doc notation.

Cc Andrew Morton <[email protected]>
Cc Steven Rostedt <[email protected]>
Cc Peter Zijlstra <[email protected]>

LKML-Reference: <[email protected]>

---
 kernel/sched.c |    2 ++
 1 files changed, 2 insertions(+), 0 deletions(-)
kernel/sched.c +2 -0
index e3f8f4f..789001d 100644
@@ -676,6 +676,7 @@ inline void update_rq_clock(struct rq *rq)
 
 /**
  * runqueue_is_locked
+ * @cpu: the processor in question.
  *
  * Returns true if the current cpu runqueue is locked.
  * This interface allows printk to be called with the runqueue lock
@@ -3660,6 +3661,7 @@ static void update_group_power(struct sched_domain *sd, int cpu)
 
 /**
  * update_sg_lb_stats - Update sched_group's statistics for load balancing.
+ * @sd: The sched_domain whose statistics are to be updated.
  * @group: sched_group whose statistics are to be updated.
  * @this_cpu: Cpu for which load balance is currently performed.
  * @idle: Idle status of this_cpu