fanotify: Link manpage in docparse comments

pevik · pevik · commit 368fd7b97b11 · 2026-03-11T14:50:00.000+01:00
Signed-off-by: Petr Vorel &lt;pvorel@suse.cz&gt;
diff --git a/testcases/kernel/syscalls/fanotify/fanotify01.c b/testcases/kernel/syscalls/fanotify/fanotify01.c
@@ -6,7 +6,7 @@
  */
 
 /*\
- * Check that fanotify work for a file.
+ * Check that :manpage:`fanotify(7)` works for a file.
  */
 
 #define _GNU_SOURCE
diff --git a/testcases/kernel/syscalls/fanotify/fanotify02.c b/testcases/kernel/syscalls/fanotify/fanotify02.c
@@ -6,7 +6,7 @@
  */
 
 /*\
- * Check that fanotify work for children of a directory.
+ * Check that :manpage:`fanotify(7)` works for children of a directory.
  */
 
 #define _GNU_SOURCE
diff --git a/testcases/kernel/syscalls/fanotify/fanotify03.c b/testcases/kernel/syscalls/fanotify/fanotify03.c
@@ -6,7 +6,7 @@
  */
 
 /*\
- * Check that fanotify permission events work.
+ * Check that :manpage:`fanotify(7)` permission events work.
  */
 
 #define _GNU_SOURCE
diff --git a/testcases/kernel/syscalls/fanotify/fanotify04.c b/testcases/kernel/syscalls/fanotify/fanotify04.c
@@ -6,7 +6,7 @@
  */
 
 /*\
- * Check various fanotify special flags.
+ * Check various :manpage:`fanotify(7)` special flags.
  */
 
 #define _GNU_SOURCE
diff --git a/testcases/kernel/syscalls/fanotify/fanotify05.c b/testcases/kernel/syscalls/fanotify/fanotify05.c
@@ -6,9 +6,10 @@
  */
 
 /*\
- * Check that fanotify overflow event is properly generated.
+ * Check that :manpage:`fanotify(7)` overflow event is properly generated.
  *
  * [Algorithm]
+ *
  * Generate enough events without reading them and check that overflow
  * event is generated.
  */
diff --git a/testcases/kernel/syscalls/fanotify/fanotify06.c b/testcases/kernel/syscalls/fanotify/fanotify06.c
@@ -6,7 +6,8 @@
  */
 
 /*\
- * Check that fanotify properly merges ignore mask of an inode and mountpoint.
+ * Check that :manpage:`fanotify(7)` properly merges ignore mask of an inode and
+ * mountpoint.
  */
 
 /*
diff --git a/testcases/kernel/syscalls/fanotify/fanotify07.c b/testcases/kernel/syscalls/fanotify/fanotify07.c
@@ -6,7 +6,8 @@
  */
 
 /*\
- * Check that fanotify permission events are handled properly on instance destruction.
+ * Check that :manpage:`fanotify(7)` permission events are handled properly on
+ * instance destruction.
  */
 
 /*
diff --git a/testcases/kernel/syscalls/fanotify/fanotify08.c b/testcases/kernel/syscalls/fanotify/fanotify08.c
@@ -6,7 +6,8 @@
  */
 
 /*\
- * Sanity check fanotify_init flag FAN_CLOEXEC by fcntl.
+ * Sanity check :manpage:`fanotify_init(2)` flag FAN_CLOEXEC by
+ * :manpage:`fcntl(2)`.
  */
 
 #define _GNU_SOURCE
diff --git a/testcases/kernel/syscalls/fanotify/fanotify09.c b/testcases/kernel/syscalls/fanotify/fanotify09.c
@@ -6,8 +6,8 @@
  */
 
 /*\
- * Check that fanotify handles events on children correctly when both parent and
- * subdir or mountpoint marks exist.
+ * Check that :manpage:`fanotify(7)` handles events on children correctly when
+ * both parent and subdir or mountpoint marks exist.
  */
 
 /*
diff --git a/testcases/kernel/syscalls/fanotify/fanotify10.c b/testcases/kernel/syscalls/fanotify/fanotify10.c
@@ -8,10 +8,10 @@
  */
 
 /*\
- * 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.
+ * Check that :manpage:`fanotify(7)` 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.
  */
 
 /*
diff --git a/testcases/kernel/syscalls/fanotify/fanotify11.c b/testcases/kernel/syscalls/fanotify/fanotify11.c
@@ -6,7 +6,7 @@
  */
 
 /*\
- * After fanotify_init adds flags FAN_REPORT_TID,
+ * After :manpage:`fanotify_init(2)` adds flags FAN_REPORT_TID,
  * check whether the program can accurately identify which thread id
  * in the multithreaded program triggered the event.
  */
diff --git a/testcases/kernel/syscalls/fanotify/fanotify12.c b/testcases/kernel/syscalls/fanotify/fanotify12.c
@@ -6,7 +6,9 @@
  */
 
 /*\
- * Validate that the newly introduced FAN_OPEN_EXEC mask functions as expected.
+ * Validate that the newly introduced :manpage:`fanotify_mark(2)` 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.
diff --git a/testcases/kernel/syscalls/fanotify/fanotify13.c b/testcases/kernel/syscalls/fanotify/fanotify13.c
@@ -6,9 +6,10 @@
  */
 
 /*\
- * 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).
+ * Validate that the values returned within an event when
+ * :manpage:`fanotify_init(2)` FAN_REPORT_FID is specified matches those that
+ * are obtained via explicit invocation to system calls :manpage:`statfs(2)` and
+ * :manpage:`name_to_handle_at(2)`.
  */
 
 /*
diff --git a/testcases/kernel/syscalls/fanotify/fanotify14.c b/testcases/kernel/syscalls/fanotify/fanotify14.c
@@ -7,10 +7,10 @@
  */
 
 /*\
- * 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.
+ * This test file has been designed to ensure that :manpage:`fanotify_init(2)`
+ * and :manpage:`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.
  */
 
 /*
diff --git a/testcases/kernel/syscalls/fanotify/fanotify15.c b/testcases/kernel/syscalls/fanotify/fanotify15.c
@@ -7,13 +7,13 @@
  */
 
 /*\
- * Test file that has been purposely designed to verify FAN_REPORT_FID
- * functionality while using newly defined dirent events.
+ * Verify FAN_REPORT_FID functionality while using newly defined
+ * :manpage:`fanotify_init(2)` dirent events.
  */
 
 /*
- * Test case #1 is a regression test for commit f367a62a7cad:
- *      fanotify: merge duplicate events on parent and child
+ * Test case #1 is a regression test for commit
+ * f367a62a7cad ("fanotify: merge duplicate events on parent and child")
  */
 
 #define _GNU_SOURCE
diff --git a/testcases/kernel/syscalls/fanotify/fanotify16.c b/testcases/kernel/syscalls/fanotify/fanotify16.c
@@ -6,8 +6,8 @@
  */
 
 /*\
- * Check fanotify directory entry modification events, events on child and
- * on self with group init flags:
+ * Check :manpage:`fanotify_init(2)` 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)
diff --git a/testcases/kernel/syscalls/fanotify/fanotify17.c b/testcases/kernel/syscalls/fanotify/fanotify17.c
@@ -8,10 +8,10 @@
  */
 
 /*\
- * 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.
- * Otherwise, we only check that global groups limit is enforced.
+ * Check that :manpage:`fanotify(7)` groups and marks limits are enforced
+ * correctly.  If user ns is supported, verify that global limit and per user ns
+ * limits are both enforced.  Otherwise, we only check that global groups limit
+ * is enforced.
  */
 
 #define _GNU_SOURCE
diff --git a/testcases/kernel/syscalls/fanotify/fanotify18.c b/testcases/kernel/syscalls/fanotify/fanotify18.c
@@ -7,8 +7,8 @@
 
 /*\
  * 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
+ * :manpage:`fanotify(7)` is functioning as expected. The objective this test
+ * case file is to validate whether any forbidden flags that are passed by an
  * unprivileged user return the correct error result.
  */
 
diff --git a/testcases/kernel/syscalls/fanotify/fanotify19.c b/testcases/kernel/syscalls/fanotify/fanotify19.c
@@ -7,10 +7,10 @@
 
 /*\
  * 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
- * contain the limited values that an unprivileged listener is expected
- * to receive.
+ * :manpage:`fanotify(7)` is functioning as expected. The objective of this test
+ * file is to generate a sequence of events and ensure that the returned events
+ * contain the limited values that an unprivileged listener is expected to
+ * receive.
  */
 
 #define _GNU_SOURCE
diff --git a/testcases/kernel/syscalls/fanotify/fanotify20.c b/testcases/kernel/syscalls/fanotify/fanotify20.c
@@ -7,13 +7,14 @@
  */
 
 /*\
- * This source file contains a test case which ensures that the fanotify API
- * returns an expected error code when provided an invalid initialization flag
- * alongside FAN_REPORT_PIDFD. Additionally, it checks that the operability with
- * existing FAN_REPORT_* flags is maintained and functioning as intended.
+ * This source file contains a test case which ensures that the
+ * :manpage:`fanotify(7)` API returns an expected error code when provided an
+ * invalid initialization flag alongside FAN_REPORT_PIDFD. Additionally, it
+ * checks that the operability with existing FAN_REPORT_* flags is maintained
+ * and functioning as intended.
  *
- * NOTE: FAN_REPORT_PIDFD support was added in v5.15-rc1 in af579beb666a
- * ("fanotify: add pidfd support to the fanotify API").
+ * NOTE: FAN_REPORT_PIDFD support was added in v5.15-rc1 in
+ * af579beb666a ("fanotify: add pidfd support to the fanotify API").
  */
 
 #define _GNU_SOURCE
diff --git a/testcases/kernel/syscalls/fanotify/fanotify21.c b/testcases/kernel/syscalls/fanotify/fanotify21.c
@@ -6,12 +6,12 @@
  */
 
 /*\
- * A test which verifies whether the returned struct
- * fanotify_event_info_pidfd in FAN_REPORT_PIDFD mode contains the
- * expected set of information.
+ * Test verifies whether the returned struct fanotify_event_info_pidfd in
+ * :manpage:`fanotify(7)` FAN_REPORT_PIDFD mode contains the expected set of
+ * information.
  *
- * NOTE: FAN_REPORT_PIDFD support was added in v5.15-rc1 in af579beb666a
- * ("fanotify: add pidfd support to the fanotify API").
+ * NOTE: FAN_REPORT_PIDFD support was added in v5.15-rc1 in
+ * af579beb666a ("fanotify: add pidfd support to the fanotify API").
  */
 
 #define _GNU_SOURCE
diff --git a/testcases/kernel/syscalls/fanotify/fanotify22.c b/testcases/kernel/syscalls/fanotify/fanotify22.c
@@ -7,7 +7,7 @@
  */
 
 /*\
- * Check fanotify FAN_ERROR_FS events triggered by intentionally
+ * Check :manpage:`fanotify(7)` FAN_ERROR_FS events triggered by intentionally
  * corrupted filesystems:
  *
  * - Generate a broken filesystem
diff --git a/testcases/kernel/syscalls/fanotify/fanotify23.c b/testcases/kernel/syscalls/fanotify/fanotify23.c
@@ -6,7 +6,7 @@
  */
 
 /*\
- * Check evictable fanotify inode marks.
+ * Check evictable :manpage:`fanotify(7)` inode marks.
  */
 
 #define _GNU_SOURCE
diff --git a/testcases/kernel/syscalls/fanotify/fanotify24.c b/testcases/kernel/syscalls/fanotify/fanotify24.c
@@ -7,10 +7,10 @@
  */
 
 /*\
- * - Test fanotify pre-content events
+ * - Test :manpage:`fanotify(7)` pre-content events
  * - Test respond to permission/pre-content events with cutsom error code
  * - Test count/offset info bug that was fixed by commit
- *   28bba2c2935e2 "fsnotify: Pass correct offset to fsnotify_mmap_perm()"
+ *   28bba2c2935e2 ("fsnotify: Pass correct offset to fsnotify_mmap_perm()")
  */
 
 #define _GNU_SOURCE
diff --git a/testcases/kernel/syscalls/fanotify/fanotify25.c b/testcases/kernel/syscalls/fanotify/fanotify25.c
@@ -6,8 +6,8 @@
  */
 
 /*\
- * Verify that fanotify monitoring can be applied to the tracing filesystem
- * and write events will be correctly delivered.
+ * Verify that :manpage:`fanotify(7)` monitoring can be applied to the tracing
+ * filesystem and write events will be correctly delivered.
  */
 
 #define _GNU_SOURCE
