linux-kernel - [tip:sched/urgent] sched: Fix docbook parameter annotation error in wait.h

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:	Sat, 25 Jan 2014 06:23:52 -0800
From:	tip-bot for Masanari Iida <tipbot@...or.com>
To:	linux-tip-commits@...r.kernel.org
Cc:	linux-kernel@...r.kernel.org, hpa@...or.com, mingo@...nel.org,
	tglx@...utronix.de, standby24x7@...il.com
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@...il.com>
AuthorDate: Wed, 22 Jan 2014 01:22:06 +0900
Committer:  Ingo Molnar <mingo@...nel.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@...il.com>
Cc: trivial@...nel.org
Cc: peterz@...radead.org
Link: http://lkml.kernel.org/r/1390321326-23120-1-git-send-email-standby24x7@gmail.com
Signed-off-by: Ingo Molnar <mingo@...nel.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
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/