seccomp: fix the kernel-doc comment for the notification structure

[PATCH] seccomp: fix the kernel-doc comment for the notification structure

Posted by Andrei Vagin 2 years, 5 months ago

Remove an empty line and resort parameters in the comment.

Fixes: 48a1084a8b74 ("seccomp: add the synchronous mode for seccomp_unotify")
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202308171742.AncabIG1-lkp@intel.com/
Signed-off-by: Andrei Vagin <avagin@google.com>
---
 kernel/seccomp.c | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/kernel/seccomp.c b/kernel/seccomp.c
index d3fdc0086168..732fca979e8b 100644
--- a/kernel/seccomp.c
+++ b/kernel/seccomp.c
@@ -141,11 +141,10 @@ struct seccomp_kaddfd {
  * @request: A semaphore that users of this notification can wait on for
  *           changes. Actual reads and writes are still controlled with
  *           filter->notify_lock.
+ * @flags: A set of SECCOMP_USER_NOTIF_FD_* flags.
  * @next_id: The id of the next request.
  * @notifications: A list of struct seccomp_knotif elements.
- * @flags: A set of SECCOMP_USER_NOTIF_FD_* flags.
  */
-
 struct notification {
 	atomic_t requests;
 	u32 flags;
-- 
2.42.0.rc1.204.g551eb34607-goog

Re: [PATCH] seccomp: fix the kernel-doc comment for the notification structure

Posted by Kees Cook 2 years, 5 months ago

On Thu, Aug 17, 2023 at 04:26:18PM -0700, Andrei Vagin wrote:
> Remove an empty line and resort parameters in the comment.
> 
> Fixes: 48a1084a8b74 ("seccomp: add the synchronous mode for seccomp_unotify")
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202308171742.AncabIG1-lkp@intel.com/
> Signed-off-by: Andrei Vagin <avagin@google.com>

Thanks! I actually just sent this patch earlier, which fixes all of the
warnings being reported for the kerndoc build:

https://lore.kernel.org/lkml/20230817194302.never.378-kees@kernel.org/

-- 
Kees Cook