History

workqueue: fix a kernel-doc warning

As warned by Sphinx: ./Documentation/core-api/workqueue:400: ./kernel/workqueue.c:1218: WARNING: Unexpected indentation. the return code table is currently not recognized, as it lacks markups.

Mauro Carvalho Chehab committed 6 years ago

Commit 3eb6b311 parent c88773d1 file · +3 −0Browse files

Showing the changes to kernel/workqueue.c (1 of 1 file). Show all

Unified · Split

kernel/workqueue.c+3−0
@@ -1212,11 +1212,14 @@ out_put: · 1211 unmodified lines
12121212 * stable state - idle, on timer or on worklist.
12131213 *
12141214 * Return:
1215+ *
1216+ * ======== ================================================================
12151217 * 1 if @work was pending and we successfully stole PENDING
12161218 * 0 if @work was idle and we claimed PENDING
12171219 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
12181220 * -ENOENT if someone else is canceling @work, this state may persist
12191221 * for arbitrarily long
1222+ * ======== ================================================================
12201223 *
12211224 * Note:
12221225 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting