lkml.org 
[lkml]   [2014]   [Jan]   [25]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
Subject[tip:sched/urgent] sched: Fix docbook parameter annotation error in wait.h
Commit-ID:  b78f4c7c4402d1070dc7ccaca6001abb4ab4053a
Gitweb: http://git.kernel.org/tip/b78f4c7c4402d1070dc7ccaca6001abb4ab4053a
Author: Masanari Iida <standby24x7@gmail.com>
AuthorDate: Wed, 22 Jan 2014 01:22:06 +0900
Committer: Ingo Molnar <mingo@kernel.org>
CommitDate: Sat, 25 Jan 2014 08:52:22 +0100

sched: Fix docbook parameter annotation error in wait.h

Missing "@" in include/linux/wait.h causes "make htmldocs" to fail
with the following warning messages:

Warning(/home/iida/Repo/linux-next//include/linux/wait.h:304):
No description found for parameter 'cmd1'
Warning(/home/iida/Repo/linux-next//include/linux/wait.h:304):
No description found for parameter 'cmd2'

Signed-off-by: Masanari Iida <standby24x7@gmail.com>
Cc: trivial@kernel.org
Cc: peterz@infradead.org
Link: http://lkml.kernel.org/r/1390321326-23120-1-git-send-email-standby24x7@gmail.com
Signed-off-by: Ingo Molnar <mingo@kernel.org>
---
include/linux/wait.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/wait.h b/include/linux/wait.h
index eaa00b1..559044c 100644
--- a/include/linux/wait.h
+++ b/include/linux/wait.h
@@ -286,8 +286,8 @@ do { \
* wait_event_cmd - sleep until a condition gets true
* @wq: the waitqueue to wait on
* @condition: a C expression for the event to wait for
- * cmd1: the command will be executed before sleep
- * cmd2: the command will be executed after sleep
+ * @cmd1: the command will be executed before sleep
+ * @cmd2: the command will be executed after sleep
*
* The process is put to sleep (TASK_UNINTERRUPTIBLE) until the
* @condition evaluates to true. The @condition is checked each time

\
 
 \ /
  Last update: 2014-01-25 16:21    [W:0.048 / U:0.120 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site