fanotify: Use docparse formatting

Signed-off-by: Petr Vorel <pvorel@suse.cz>

19 files changed, 136 insertions, 86 deletions

diff --git a/testcases/kernel/syscalls/fanotify/fanotify01.c b/testcases/kernel/syscalls/fanotify/fanotify01.c
index 2fe4a9457..6b64e5b13 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify01.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify01.c
@@ -3,10 +3,13 @@
  * Copyright (c) 2013 SUSE.  All Rights Reserved.
  *
  * Started by Jan Kara <jack@suse.cz>
- *
- * DESCRIPTION
- *     Check that fanotify work for a file
  */
+
+/*\
+ * [Description]
+ * Check that fanotify work for a file.
+ */
+
 #define _GNU_SOURCE
 #include "config.h"
 
diff --git a/testcases/kernel/syscalls/fanotify/fanotify02.c b/testcases/kernel/syscalls/fanotify/fanotify02.c
index b4fb33136..eb40a2e24 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify02.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify02.c
@@ -3,10 +3,13 @@
  * Copyright (c) 2013 SUSE.  All Rights Reserved.
  *
  * Started by Jan Kara <jack@suse.cz>
- *
- * DESCRIPTION
- *     Check that fanotify work for children of a directory
  */
+
+/*\
+ * [Description]
+ * Check that fanotify work for children of a directory.
+ */
+
 #define _GNU_SOURCE
 #include "config.h"
 
diff --git a/testcases/kernel/syscalls/fanotify/fanotify03.c b/testcases/kernel/syscalls/fanotify/fanotify03.c
index a8cf4348a..26d17e64d 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify03.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify03.c
@@ -3,10 +3,13 @@
  * Copyright (c) 2013 SUSE.  All Rights Reserved.
  *
  * Started by Jan Kara <jack@suse.cz>
- *
- * DESCRIPTION
- *     Check that fanotify permission events work
  */
+
+/*\
+ * [Description]
+ * Check that fanotify permission events work.
+ */
+
 #define _GNU_SOURCE
 #include "config.h"
 
diff --git a/testcases/kernel/syscalls/fanotify/fanotify04.c b/testcases/kernel/syscalls/fanotify/fanotify04.c
index 023267183..b23d7a9a3 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify04.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify04.c
@@ -3,9 +3,11 @@
  * Copyright (c) 2013 SUSE.  All Rights Reserved.
  *
  * Started by Jan Kara <jack@suse.cz>
- *
- * DESCRIPTION
- *     Check various fanotify special flags
+ */
+
+/*\
+ * [Description]
+ * Check various fanotify special flags.
  */
 
 #define _GNU_SOURCE
diff --git a/testcases/kernel/syscalls/fanotify/fanotify05.c b/testcases/kernel/syscalls/fanotify/fanotify05.c
index b7028f262..1c683c4c0 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify05.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify05.c
@@ -3,14 +3,17 @@
  * Copyright (c) 2014 SUSE Linux.  All Rights Reserved.
  *
  * Started by Jan Kara <jack@suse.cz>
+ */
+
+/*\
+ * [Description]
+ * Check that fanotify overflow event is properly generated.
  *
- * DESCRIPTION
- *     Check that fanotify overflow event is properly generated
- *
- * ALGORITHM
- *     Generate enough events without reading them and check that overflow
- *     event is generated.
+ * [Algorithm]
+ * Generate enough events without reading them and check that overflow
+ * event is generated.
  */
+
 #define _GNU_SOURCE
 #include "config.h"
 
diff --git a/testcases/kernel/syscalls/fanotify/fanotify06.c b/testcases/kernel/syscalls/fanotify/fanotify06.c
index 48a90edf9..30055da4b 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify06.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify06.c
@@ -3,11 +3,14 @@
  * Copyright (c) 2014 SUSE.  All Rights Reserved.
  *
  * Started by Jan Kara <jack@suse.cz>
- *
- * DESCRIPTION
- *     Check that fanotify properly merges ignore mask of an inode and
- *     mountpoint.
- *
+ */
+
+/*\
+ * [Description]
+ * Check that fanotify properly merges ignore mask of an inode and mountpoint.
+ */
+
+/*
  * This is a regression test for:
  *
  *  commit 8edc6e1688fc8f02c8c1f53a2ec4928cb1055f4d
@@ -24,6 +27,7 @@
  *
  *      ovl: do not generate duplicate fsnotify events for "fake" path
  */
+
 #define _GNU_SOURCE
 #include "config.h"
 
diff --git a/testcases/kernel/syscalls/fanotify/fanotify07.c b/testcases/kernel/syscalls/fanotify/fanotify07.c
index 631a9a20c..cc56d9019 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify07.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify07.c
@@ -3,17 +3,21 @@
  * Copyright (c) 2017 SUSE.  All Rights Reserved.
  *
  * Started by Jan Kara <jack@suse.cz>
- *
- * DESCRIPTION
- *     Check that fanotify permission events are handled properly on instance
- *     destruction.
- *
+ */
+
+/*\
+ * [Description]
+ * Check that fanotify permission events are handled properly on instance destruction.
+ */
+
+/*
  * Kernel crashes should be fixed by:
  *  96d41019e3ac "fanotify: fix list corruption in fanotify_get_response()"
  *
  * Kernel hangs should be fixed by:
  *  05f0e38724e8 "fanotify: Release SRCU lock when waiting for userspace response"
  */
+
 #define _GNU_SOURCE
 #include "config.h"
 
diff --git a/testcases/kernel/syscalls/fanotify/fanotify08.c b/testcases/kernel/syscalls/fanotify/fanotify08.c
index 6a59719f3..f86b56752 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify08.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify08.c
@@ -3,10 +3,13 @@
  * Copyright (c) 2017 RedHat.  All Rights Reserved.
  *
  * Started by Xiong Zhou <xzhou@redhat.com>
- *
- * DESCRIPTION
- *     Sanity check fanotify_init flag FAN_CLOEXEC by fcntl.
  */
+
+/*\
+ * [Description]
+ * Sanity check fanotify_init flag FAN_CLOEXEC by fcntl.
+ */
+
 #define _GNU_SOURCE
 #include "config.h"
 
diff --git a/testcases/kernel/syscalls/fanotify/fanotify09.c b/testcases/kernel/syscalls/fanotify/fanotify09.c
index 089655d29..d622ff3a2 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify09.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify09.c
@@ -3,11 +3,15 @@
  * Copyright (c) 2018 CTERA Networks.  All Rights Reserved.
  *
  * Started by Amir Goldstein <amir73il@gmail.com>
- *
- * DESCRIPTION
- *     Check that fanotify handles events on children correctly when
- *     both parent and subdir or mountpoint marks exist.
- *
+ */
+
+/*\
+ * [Description]
+ * Check that fanotify handles events on children correctly when both parent and
+ * subdir or mountpoint marks exist.
+ */
+
+/*
  * This is a regression test for commit 54a307ba8d3c:
  *
  *      fanotify: fix logic of events on child
@@ -24,6 +28,7 @@
  *
  *      fanotify: fix logic of reporting name info with watched parent
  */
+
 #define _GNU_SOURCE
 #include "config.h"
 
diff --git a/testcases/kernel/syscalls/fanotify/fanotify10.c b/testcases/kernel/syscalls/fanotify/fanotify10.c
index eeba87568..92e4d3ff3 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify10.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify10.c
@@ -5,13 +5,17 @@
  *
  * Started by Jan Kara <jack@suse.cz>
  * Forked from fanotify06.c by Amir Goldstein <amir73il@gmail.com>
- *
- * DESCRIPTION
- *     Check that fanotify properly merges ignore mask of a mount mark
- *     with a mask of an inode mark on the same group.  Unlike the
- *     prototype test fanotify06, do not use FAN_MODIFY event for the
- *     test mask, because it hides the bug.
- *
+ */
+
+/*\
+ * [Description]
+ * Check that fanotify properly merges ignore mask of a mount mark
+ * with a mask of an inode mark on the same group.  Unlike the
+ * prototype test fanotify06, do not use FAN_MODIFY event for the
+ * test mask, because it hides the bug.
+ */
+
+/*
  * This is a regression test for commit:
  *
  *     9bdda4e9cf2d fsnotify: fix ignore mask logic in fsnotify()
@@ -25,6 +29,7 @@
  *
  *     497b0c5a7c06 fsnotify: send event to parent and child with single...
  */
+
 #define _GNU_SOURCE
 #include "config.h"
 
diff --git a/testcases/kernel/syscalls/fanotify/fanotify11.c b/testcases/kernel/syscalls/fanotify/fanotify11.c
index 4fde9747b..b21c986cc 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify11.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify11.c
@@ -3,13 +3,15 @@
  * Copyright (c) 2018 Huawei.  All Rights Reserved.
  *
  * Started by nixiaoming <nixiaoming@huawei.com>
- *
- * DESCRIPTION
- *     After fanotify_init adds flags FAN_REPORT_TID,
- *     check whether the program can accurately identify which thread id
- *     in the multithreaded program triggered the event.
- *
  */
+
+/*\
+ * [Description]
+ * After fanotify_init adds flags FAN_REPORT_TID,
+ * check whether the program can accurately identify which thread id
+ * in the multithreaded program triggered the event.
+ */
+
 #define _GNU_SOURCE
 #include "config.h"
 
diff --git a/testcases/kernel/syscalls/fanotify/fanotify12.c b/testcases/kernel/syscalls/fanotify/fanotify12.c
index 17086ef71..76f1aca77 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify12.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify12.c
@@ -3,14 +3,16 @@
  * Copyright (c) 2018 Matthew Bobrowski. All Rights Reserved.
  *
  * Started by Matthew Bobrowski <mbobrowski@mbobrowski.org>
- *
- * DESCRIPTION
- *	Validate that the newly introduced FAN_OPEN_EXEC mask functions as
- *	expected. The idea is to generate a sequence of open related
- *	actions to ensure that the correct event flags are being set
- *	depending on what event mask was requested when the object was
- *	marked.
  */
+
+/*\
+ * [Description]
+ * Validate that the newly introduced FAN_OPEN_EXEC mask functions as expected.
+ * The idea is to generate a sequence of open related actions to ensure that
+ * the correct event flags are being set depending on what event mask was
+ * requested when the object was marked.
+ */
+
 #define _GNU_SOURCE
 #include "config.h"
 
diff --git a/testcases/kernel/syscalls/fanotify/fanotify13.c b/testcases/kernel/syscalls/fanotify/fanotify13.c
index 1fb12ae68..9061c1ffe 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify13.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify13.c
@@ -3,16 +3,20 @@
  * Copyright (c) 2018 Matthew Bobrowski. All Rights Reserved.
  *
  * Started by Matthew Bobrowski <mbobrowski@mbobrowski.org>
- *
- * DESCRIPTION
- *	Validate that the values returned within an event when
- *	FAN_REPORT_FID is specified matches those that are obtained via
- *	explicit invocation to system calls statfs(2) and
- *	name_to_handle_at(2).
- *
+ */
+
+/*\
+ * [Description]
+ * Validate that the values returned within an event when FAN_REPORT_FID is
+ * specified matches those that are obtained via explicit invocation to system
+ * calls statfs(2) and name_to_handle_at(2).
+ */
+
+ /*
  * This is also regression test for:
  *     c285a2f01d69 ("fanotify: update connector fsid cache on add mark")
  */
+
 #define _GNU_SOURCE
 #include "config.h"
 
diff --git a/testcases/kernel/syscalls/fanotify/fanotify14.c b/testcases/kernel/syscalls/fanotify/fanotify14.c
index 817d5ecd5..d19d5576a 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify14.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify14.c
@@ -3,13 +3,16 @@
  * Copyright (c) 2018 Matthew Bobrowski. All Rights Reserved.
  *
  * Started by Matthew Bobrowski <mbobrowski@mbobrowski.org>
- *
- * DESCRIPTION
- *	This test file has been designed to ensure that the fanotify
- *	system calls fanotify_init(2) and fanotify_mark(2) return the
- *	correct error code to the calling process when an invalid flag or
- *	mask value has been specified in conjunction with FAN_REPORT_FID.
  */
+
+/*\
+ * [Description]
+ * This test file has been designed to ensure that the fanotify
+ * system calls fanotify_init(2) and fanotify_mark(2) return the
+ * correct error code to the calling process when an invalid flag or
+ * mask value has been specified in conjunction with FAN_REPORT_FID.
+ */
+
 #define _GNU_SOURCE
 #include "tst_test.h"
 #include <errno.h>
diff --git a/testcases/kernel/syscalls/fanotify/fanotify15.c b/testcases/kernel/syscalls/fanotify/fanotify15.c
index fe143823e..a7736af90 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify15.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify15.c
@@ -4,16 +4,19 @@
  *
  * Started by Amir Goldstein <amir73il@gmail.com>
  * Modified by Matthew Bobrowski <mbobrowski@mbobrowski.org>
- *
- * DESCRIPTION
- *	Test file that has been purposely designed to verify
- *	FAN_REPORT_FID functionality while using newly defined dirent
- *	events.
- *
+ */
+
+/*\
+ * [Description]
+ * Test file that has been purposely designed to verify FAN_REPORT_FID
+ * functionality while using newly defined dirent events.
+ */
+
+/*
  * Test case #1 is a regression test for commit f367a62a7cad:
- *
  *      fanotify: merge duplicate events on parent and child
  */
+
 #define _GNU_SOURCE
 #include "config.h"
 
diff --git a/testcases/kernel/syscalls/fanotify/fanotify16.c b/testcases/kernel/syscalls/fanotify/fanotify16.c
index 801d05cc2..357f4216b 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify16.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify16.c
@@ -3,15 +3,19 @@
  * Copyright (c) 2020 CTERA Networks. All Rights Reserved.
  *
  * Started by Amir Goldstein <amir73il@gmail.com>
+ */
+
+/*\
+ * [Description]
+ * Check fanotify directory entry modification events, events on child and
+ * on self with group init flags:
  *
- * DESCRIPTION
- *     Check fanotify directory entry modification events, events on child and
- *     on self with group init flags:
- *     - FAN_REPORT_DFID_NAME (dir fid + name)
- *     - FAN_REPORT_DIR_FID   (dir fid)
- *     - FAN_REPORT_DIR_FID | FAN_REPORT_FID   (dir fid + child fid)
- *     - FAN_REPORT_DFID_NAME | FAN_REPORT_FID (dir fid + name + child fid)
+ * - FAN_REPORT_DFID_NAME (dir fid + name)
+ * - FAN_REPORT_DIR_FID   (dir fid)
+ * - FAN_REPORT_DIR_FID | FAN_REPORT_FID   (dir fid + child fid)
+ * - FAN_REPORT_DFID_NAME | FAN_REPORT_FID (dir fid + name + child fid)
  */
+
 #define _GNU_SOURCE
 #include "config.h"
 
diff --git a/testcases/kernel/syscalls/fanotify/fanotify17.c b/testcases/kernel/syscalls/fanotify/fanotify17.c
index 98355a7b4..35beb53d2 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify17.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify17.c
@@ -9,7 +9,6 @@
 
 /*\
  * [Description]
- *
  * Check that fanotify groups and marks limits are enforced correctly.
  * If user ns is supported, verify that global limit and per user ns
  * limits are both enforced.
diff --git a/testcases/kernel/syscalls/fanotify/fanotify18.c b/testcases/kernel/syscalls/fanotify/fanotify18.c
index 318245efc..8a7eebba3 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify18.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify18.c
@@ -7,7 +7,6 @@
 
 /*\
  * [Description]
- *
  * This set of tests is to ensure that the unprivileged listener feature of
  * fanotify is functioning as expected. The objective this test case file
  * is to validate whether any forbidden flags that are passed by an
diff --git a/testcases/kernel/syscalls/fanotify/fanotify19.c b/testcases/kernel/syscalls/fanotify/fanotify19.c
index 92ed45e49..e4ac8a032 100644
--- a/testcases/kernel/syscalls/fanotify/fanotify19.c
+++ b/testcases/kernel/syscalls/fanotify/fanotify19.c
@@ -7,7 +7,6 @@
 
 /*\
  * [Description]
- *
  * This set of tests is to ensure that the unprivileged listener feature of
  * fanotify is functioning as expected. The objective of this test file is
  * to generate a sequence of events and ensure that the returned events