docbook: add fs/eventfd.c kernel-doc
Subsystems (2)
PATCH 1/1 docbook: add fs/eventfd.c kernel-doc
From: Randy Dunlap <[email protected]>
Add fs/eventfd.c to filesystems docbook.
Make typo corrections in fs/eventfd.c.
Signed-off-by Randy Dunlap <[email protected]>
Cc Davide Libenzi <[email protected]>
--- Documentation/DocBook/filesystems.tmpl | 5 +++++ fs/eventfd.c | 12 ++++++------ 2 files changed, 11 insertions(+), 6 deletions(-)
Documentation/DocBook/filesystems.tmpl +5 -0
@@ -82,6 +82,11 @@ </sect1> </chapter> + <chapter id="fs_events"> + <title>Events based on file descriptors</title> +!Efs/eventfd.c + </chapter> + <chapter id="sysfs"> <title>The Filesystem for Exporting Kernel Objects</title> !Efs/sysfs/file.c
fs/eventfd.c +6 -6
@@ -99,7 +99,7 @@ EXPORT_SYMBOL_GPL(eventfd_ctx_get);* @ctx: [in] Pointer to eventfd context. * * The eventfd context reference must have been previously acquired either -* with eventfd_ctx_get() or eventfd_ctx_fdget()). +* with eventfd_ctx_get() or eventfd_ctx_fdget(). */ void eventfd_ctx_put (struct eventfd_ctx *ctx) {
@@ -146,9 +146,9 @@ static void eventfd_ctx_do_read(struct e* eventfd_ctx_remove_wait_queue - Read the current counter and removes wait queue. * @ctx: [in] Pointer to eventfd context. * @wait: [in] Wait queue to be removed. -* @cnt: [out] Pointer to the 64bit conter value. +* @cnt: [out] Pointer to the 64-bit counter value. * -* Returns zero if successful, or the following error codes: +* Returns %0 if successful, or the following error codes: * * -EAGAIN : The operation would have blocked. *
@@ -175,11 +175,11 @@ EXPORT_SYMBOL_GPL(eventfd_ctx_remove_wai* eventfd_ctx_read - Reads the eventfd counter or wait if it is zero. * @ctx: [in] Pointer to eventfd context. * @no_wait: [in] Different from zero if the operation should not block. -* @cnt: [out] Pointer to the 64bit conter value. +* @cnt: [out] Pointer to the 64-bit counter value. * -* Returns zero if successful, or the following error codes: +* Returns %0 if successful, or the following error codes: * -* -EAGAIN : The operation would have blocked but @no_wait was nonzero. +* -EAGAIN : The operation would have blocked but @no_wait was non-zero. * -ERESTARTSYS : A signal interrupted the wait operation. * * If @no_wait is zero, the function might sleep until the eventfd internal
---