diff mbox series

[2/2] Documentation: add eventpoll to fs api-summary book

Message ID 20201016033805.13784-1-rdunlap@infradead.org (mailing list archive)
State New
Headers show
Series [1/2] fs/eventpoll.c: fix Returns: kernel-doc notation | expand

Commit Message

Randy Dunlap Oct. 16, 2020, 3:38 a.m. UTC 
Add fs/eventpoll.c to the filesystem api-summary book.

Fix kernel-doc warnings in eventpoll.c:

../fs/eventpoll.c:1132: warning: Function parameter or member 'new' not described in 'list_add_tail_lockless'
../fs/eventpoll.c:1132: warning: Function parameter or member 'head' not described in 'list_add_tail_lockless'
../fs/eventpoll.c:1172: warning: Function parameter or member 'epi' not described in 'chain_epi_lockless'

Also remove kernel-doc begin notation (/**) from reverse_path_check()
and some other comment blocks.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Alexander Viro <viro@zeniv.linux.org.uk>
---
 Documentation/filesystems/api-summary.rst |    6 ++++++
 fs/eventpoll.c                            |    6 +++---
 2 files changed, 9 insertions(+), 3 deletions(-)
diff mbox series

Patch

--- linux-next-20201013.orig/Documentation/filesystems/api-summary.rst
+++ linux-next-20201013/Documentation/filesystems/api-summary.rst
@@ -125,6 +125,12 @@  Events based on file descriptors
 .. kernel-doc:: fs/eventfd.c
    :export:
 
+eventpoll (epoll) interfaces
+============================
+
+.. kernel-doc:: fs/eventpoll.c
+   :internal:
+
 The Filesystem for Exporting Kernel Objects
 ===========================================
 
--- linux-next-20201013.orig/fs/eventpoll.c
+++ linux-next-20201013/fs/eventpoll.c
@@ -1106,7 +1106,7 @@  struct file *get_epoll_tfile_raw_ptr(str
 }
 #endif /* CONFIG_CHECKPOINT_RESTORE */
 
-/**
+/*
  * Adds a new entry to the tail of the list in a lockless way, i.e.
  * multiple CPUs are allowed to call this function concurrently.
  *
@@ -1159,7 +1159,7 @@  static inline bool list_add_tail_lockles
 	return true;
 }
 
-/**
+/*
  * Chains a new epi entry to the tail of the ep->ovflist in a lockless way,
  * i.e. multiple CPUs are allowed to call this function concurrently.
  *
@@ -1419,7 +1419,7 @@  static int reverse_path_check_proc(void
 	return error;
 }
 
-/**
+/*
  * reverse_path_check - The tfile_check_list is list of file *, which have
  *                      links that are proposed to be newly added. We need to
  *                      make sure that those added links don't add too many