ioctl02: docparse: Use links to man

pevik · pevik · commit bb13c18e3b0d · 2025-12-08T11:02:50.000+01:00
Signed-off-by: Petr Vorel &lt;pvorel@suse.cz&gt;
diff --git a/testcases/kernel/syscalls/ioctl/ioctl01.c b/testcases/kernel/syscalls/ioctl/ioctl01.c
@@ -8,7 +8,7 @@
  */
 
 /*\
- * Testcase to check the errnos set by the ioctl(2) system call.
+ * Testcase to check the errnos set by the :man2:`ioctl` system call.
  *
  * - EBADF: Pass an invalid fd to ioctl(fd, ...) and expect EBADF
  * - EFAULT: Pass an invalid address of arg in ioctl(fd, ..., arg)
diff --git a/testcases/kernel/syscalls/ioctl/ioctl04.c b/testcases/kernel/syscalls/ioctl/ioctl04.c
@@ -4,7 +4,7 @@
  */
 
 /*\
- * Basic test for the BLKROSET and BLKROGET ioctls.
+ * Basic test for :man2:`ioctl` with BLKROSET and BLKROGET .
  *
  * - Set the device read only, read the value back.
  * - Try to mount the device read write, expect failure.
diff --git a/testcases/kernel/syscalls/ioctl/ioctl05.c b/testcases/kernel/syscalls/ioctl/ioctl05.c
@@ -4,7 +4,7 @@
  */
 
 /*\
- * Basic test for the BLKGETSIZE and BLKGETSIZE64 ioctls.
+ * Basic test for :man2:`ioctl` with BLKGETSIZE and BLKGETSIZE64.
  *
  * - BLKGETSIZE returns size in 512 byte blocks BLKGETSIZE64 in bytes
  *   compare that they return the same value.
diff --git a/testcases/kernel/syscalls/ioctl/ioctl06.c b/testcases/kernel/syscalls/ioctl/ioctl06.c
@@ -4,7 +4,7 @@
  */
 
 /*\
- * Basic test for the BLKRASET and BLKRAGET ioctls.
+ * Basic test for :man2:`ioctl` with BLKRASET and BLKRAGET.
  *
  * Sets device read-ahead, reads it back and compares the values.
  *
diff --git a/testcases/kernel/syscalls/ioctl/ioctl07.c b/testcases/kernel/syscalls/ioctl/ioctl07.c
@@ -4,7 +4,7 @@
  */
 
 /*\
- * Very basic test for the RND* ioctls.
+ * Very basic test for the RND* :man2:`ioctl`.
  *
  * Reads the entropy available from both /proc and the ioctl and compares
  * they are similar enough (within a configured fuzz factor).
diff --git a/testcases/kernel/syscalls/ioctl/ioctl08.c b/testcases/kernel/syscalls/ioctl/ioctl08.c
@@ -5,7 +5,7 @@
  */
 
 /*\
- * Tests the ioctl functionality to deduplicate fileranges using
+ * Tests :man2:`ioctl` functionality to deduplicate fileranges using
  * btrfs filesystem.
  *
  * 1. Sets the same contents for two files and deduplicates it.
diff --git a/testcases/kernel/syscalls/ioctl/ioctl09.c b/testcases/kernel/syscalls/ioctl/ioctl09.c
@@ -5,7 +5,7 @@
  */
 
 /*\
- * Basic test for the BLKRRPART ioctl, it is the same as blockdev
+ * Basic test for :man2:`ioctl` with BLKRRPART, it is the same as blockdev
  * --rereadpt command.
  */
 
diff --git a/testcases/kernel/syscalls/ioctl/ioctl10.c b/testcases/kernel/syscalls/ioctl/ioctl10.c
@@ -4,7 +4,7 @@
  */
 
 /*\
- * Test PROCMAP_QUERY ioctl() for /proc/$PID/maps.
+ * Test PROCMAP_QUERY :man2:`ioctl` for /proc/$PID/maps.
  *
  * Test based on :kselftest:`proc/proc-pid-vm.c`.
  *
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_ficlone01.c b/testcases/kernel/syscalls/ioctl/ioctl_ficlone01.c
@@ -4,8 +4,8 @@
  */
 
 /*\
- * This test verifies that ioctl() FICLONE feature clones file content from
- * one file to an another.
+ * This test verifies that :man2:`ioctl` FICLONE feature clones file content
+ * from one file to an another.
  *
  * [Algorithm]
  *
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_ficlone02.c b/testcases/kernel/syscalls/ioctl/ioctl_ficlone02.c
@@ -4,9 +4,9 @@
  */
 
 /*\
- * This test verifies that ioctl() FICLONE/FICLONERANGE feature correctly raises
- * EOPNOTSUPP when an unsupported filesystem is used. In particular, filesystems
- * which don't support copy-on-write.
+ * This test verifies that :man2:`ioctl` FICLONE/FICLONERANGE feature correctly
+ * raises EOPNOTSUPP when an unsupported filesystem is used. In particular,
+ * filesystems which don't support copy-on-write.
  */
 
 #include "tst_test.h"
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_ficlone03.c b/testcases/kernel/syscalls/ioctl/ioctl_ficlone03.c
@@ -4,8 +4,8 @@
  */
 
 /*\
- * This test verifies that ioctl() FICLONE/FICLONERANGE feature correctly raises
- * exceptions when it's supposed to.
+ * This test verifies that :man2:`ioctl` FICLONE/FICLONERANGE feature correctly
+ * raises exceptions when it's supposed to.
  */
 
 #include "tst_test.h"
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_ficlone04.c b/testcases/kernel/syscalls/ioctl/ioctl_ficlone04.c
@@ -4,8 +4,8 @@
  */
 
 /*\
- * This test verifies that ioctl() FICLONE/FICLONERANGE feature raises the right
- * error according with bad file descriptors.
+ * This test verifies that :man2:`ioctl` FICLONE/FICLONERANGE feature raises the
+ * right error according with bad file descriptors.
  */
 
 #include "tst_test.h"
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_ficlonerange01.c b/testcases/kernel/syscalls/ioctl/ioctl_ficlonerange01.c
@@ -4,8 +4,8 @@
  */
 
 /*\
- * This test verifies that ioctl() FICLONERANGE feature clones file content from
- * one file to an another.
+ * This test verifies that :man2:`ioctl` FICLONERANGE feature clones file
+ * content from one file to an another.
  *
  * [Algorithm]
  *
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_ficlonerange02.c b/testcases/kernel/syscalls/ioctl/ioctl_ficlonerange02.c
@@ -4,8 +4,9 @@
  */
 
 /*\
- * This test verifies that ioctl() FICLONERANGE feature correctly raises
+ * This test verifies that :man2:`ioctl` FICLONERANGE feature correctly raises
  * EINVAL when:
+ *
  * - filesystem does not support overlapping reflink ranges in the same file
  * - filesystem does not support reflinking on bad blocks alignment
  */
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_loop01.c b/testcases/kernel/syscalls/ioctl/ioctl_loop01.c
@@ -6,7 +6,8 @@
  */
 
 /*\
- * Tests ioctl() on loopdevice with LO_FLAGS_AUTOCLEAR and LO_FLAGS_PARTSCAN flags.
+ * Tests :man2:`ioctl` on loopdevice with LO_FLAGS_AUTOCLEAR and
+ * LO_FLAGS_PARTSCAN flags.
  *
  * For LO_FLAGS_AUTOCLEAR flag, only checks autoclear field value in sysfs
  * and also gets lo_flags by using LOOP_GET_STATUS.
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_loop02.c b/testcases/kernel/syscalls/ioctl/ioctl_loop02.c
@@ -6,14 +6,14 @@
  */
 
 /*\
- * Tests ioctl() on loopdevice with LO_FLAGS_READ_ONLY (similar as losetup -r) and
- * LOOP_CHANGE_FD flags.
+ * Tests :man2:`ioctl` on loopdevice with LO_FLAGS_READ_ONLY (similar as losetup
+ * -r) and LOOP_CHANGE_FD flags.
  *
  * For LOOP_CHANGE_FD, this operation is possible only if the loop device
  * is read-only and the new backing store is the same size and type as the
  * old backing store.
  *
- * When using LOOP_CONFIGURE ioctl(), it can set LO_FLAGS_READ_ONLY
+ * When using LOOP_CONFIGURE :man2:`ioctl`, it can set LO_FLAGS_READ_ONLY
  * flag even though backing file with write mode.
  */
 
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_loop03.c b/testcases/kernel/syscalls/ioctl/ioctl_loop03.c
@@ -6,7 +6,7 @@
  */
 
 /*\
- * Tests ioctl() on loopdevice with LOOP_CHANGE_FD flag.
+ * Tests :man2:`ioctl` on loopdevice with LOOP_CHANGE_FD flag.
  *
  * Tests whether LOOP_CHANGE_FD can not succeed (get EINVAL error)
  * when loop_dev is not read only.
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_loop04.c b/testcases/kernel/syscalls/ioctl/ioctl_loop04.c
@@ -6,7 +6,7 @@
  */
 
 /*\
- * Tests ioctl() on loopdevice with LOOP_SET_CAPACITY flag.
+ * Tests :man2:`ioctl` on loopdevice with LOOP_SET_CAPACITY flag.
  *
  * Tests whether LOOP_SET_CAPACITY can update a live
  * loop device size after change the size of the underlying
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_loop05.c b/testcases/kernel/syscalls/ioctl/ioctl_loop05.c
@@ -6,7 +6,7 @@
  */
 
 /*\
- * Tests ioctl() on loopdevice with LOOP_SET_DIRECT_IO flag.
+ * Tests :man2:`ioctl` on loopdevice with LOOP_SET_DIRECT_IO flag.
  *
  * Tests whether LOOP_SET_DIRECT_IO can update a live loop device dio mode.
  * It requires the backing file also supports dio mode and the lo_offset is
@@ -16,8 +16,8 @@
  * return error when it coudln't be enabled, some silently fall back to regular
  * buffered I/O.
  *
- * The LOOP_SET_DIRECT_IO ioctl() may ignore all checks if it cannot get the
- * logical block size which is the case if the block device pointer in the
+ * The LOOP_SET_DIRECT_IO :man2:`ioctl` may ignore all checks if it cannot get
+ * the logical block size which is the case if the block device pointer in the
  * backing file inode is not set. In this case the direct I/O appears to be
  * enabled but falls back to buffered I/O later on. This is the case at least
  * for Btrfs. Because of that the test passes both with failure as well as
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_loop06.c b/testcases/kernel/syscalls/ioctl/ioctl_loop06.c
@@ -6,7 +6,7 @@
  */
 
 /*\
- * Tests invalid block size of loopdevice by using ioctl() with
+ * Tests invalid block size of loopdevice by using :man2:`ioctl` with
  * LOOP_SET_BLOCK_SIZE and LOOP_CONFIGURE flags.
  */
 
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_loop07.c b/testcases/kernel/syscalls/ioctl/ioctl_loop07.c
@@ -6,7 +6,8 @@
  */
 
 /*\
- * Tests ioctl() on loopdevice with LOOP_SET_STATUS64 and LOOP_GET_STATUS64 flags.
+ * Tests :man2:`ioctl` on loopdevice with LOOP_SET_STATUS64 and
+ * LOOP_GET_STATUS64 flags.
  *
  * Tests lo_sizelimit field. If lo_sizelimit is 0, it means max
  * available. If sizelimit is less than loop_size, loopsize will
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_pidfd01.c b/testcases/kernel/syscalls/ioctl/ioctl_pidfd01.c
@@ -4,8 +4,8 @@
  */
 
 /*\
- * Verify that ioctl() raises the right errors when an application provides
- * the wrong file descriptor.
+ * Verify that :man2:`ioctl` raises the right errors when an application
+ * provides wrong file descriptor.
  */
 
 #include "ioctl_pidfd.h"
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_pidfd02.c b/testcases/kernel/syscalls/ioctl/ioctl_pidfd02.c
@@ -4,7 +4,7 @@
  */
 
 /*\
- * Check if the ioctl() function allows retrieval of a child's exit code
+ * Check if the :man2:`ioctl` function allows retrieval of a child's exit code
  * using PIDFD_INFO_EXIT from a process that can be isolated or not from the
  * child.
  */
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_pidfd03.c b/testcases/kernel/syscalls/ioctl/ioctl_pidfd03.c
@@ -4,9 +4,9 @@
  */
 
 /*\
- * Verify that ioctl() returns ESRCH when a process attempts to access the
- * exit status of an isolated child using `PIDFD_GET_INFO` and
- * `PIDFD_INFO_EXIT` is not defined in `struct pidfd_info`.
+ * Verify that :man2:`ioctl` returns ESRCH when a process attempts to access the
+ * exit status of an isolated child using PIDFD_GET_INFO and PIDFD_INFO_EXIT
+ * is not defined in struct pidfd_info.
  */
 
 #include "ioctl_pidfd.h"
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_pidfd04.c b/testcases/kernel/syscalls/ioctl/ioctl_pidfd04.c
@@ -4,8 +4,8 @@
  */
 
 /*\
- * Verify that ioctl() permits to obtain the exit code of an isolated signaled
- * child via PIDFD_INFO_EXIT from within a process.
+ * Verify that :man2:`ioctl` permits to obtain the exit code of an isolated
+ * signaled child via PIDFD_INFO_EXIT from within a process.
  */
 
 #include "ioctl_pidfd.h"
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_pidfd05.c b/testcases/kernel/syscalls/ioctl/ioctl_pidfd05.c
@@ -4,8 +4,8 @@
  */
 
 /*\
- * Verify that ioctl() raises an EINVAL or ENOTTY (since v6.18-rc1) error when
- * PIDFD_GET_INFO is used. This happens when:
+ * Verify that :man2:`ioctl` raises an EINVAL or ENOTTY (since v6.18-rc1) error
+ * when PIDFD_GET_INFO is used. This happens when:
  *
  * - info parameter is NULL
  * - info parameter is providing the wrong size
diff --git a/testcases/kernel/syscalls/ioctl/ioctl_pidfd06.c b/testcases/kernel/syscalls/ioctl/ioctl_pidfd06.c
@@ -4,7 +4,7 @@
  */
 
 /*\
- * Verify that ioctl() doesn't allow to obtain the exit status of an isolated
+ * Verify that :man2:`ioctl` doesn't allow to obtain the exit status of an isolated
  * process via PIDFD_INFO_EXIT in within an another isolated process, which
  * doesn't have any parent connection.
  */

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`*/`
`9`	`9`
`10`	`10`	`/*\`
`11`		`- * Testcase to check the errnos set by the ioctl(2) system call.`
	`11`	+ * Testcase to check the errnos set by the :man2:`ioctl` system call.
`12`	`12`	`*`
`13`	`13`	`* - EBADF: Pass an invalid fd to ioctl(fd, ...) and expect EBADF`
`14`	`14`	`* - EFAULT: Pass an invalid address of arg in ioctl(fd, ..., arg)`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`*/`
`5`	`5`
`6`	`6`	`/*\`
`7`		`- * Basic test for the BLKROSET and BLKROGET ioctls.`
	`7`	+ * Basic test for :man2:`ioctl` with BLKROSET and BLKROGET .
`8`	`8`	`*`
`9`	`9`	`* - Set the device read only, read the value back.`
`10`	`10`	`* - Try to mount the device read write, expect failure.`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`*/`
`6`	`6`
`7`	`7`	`/*\`
`8`		`- * Tests the ioctl functionality to deduplicate fileranges using`
	`8`	+ * Tests :man2:`ioctl` functionality to deduplicate fileranges using
`9`	`9`	`* btrfs filesystem.`
`10`	`10`	`*`
`11`	`11`	`* 1. Sets the same contents for two files and deduplicates it.`
Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,8 @@`
`4`	`4`	`*/`
`5`	`5`
`6`	`6`	`/*\`
`7`		`- * This test verifies that ioctl() FICLONE feature clones file content from`
`8`		`- * one file to an another.`
	`7`	+ * This test verifies that :man2:`ioctl` FICLONE feature clones file content
	`8`	`+ * from one file to an another.`
`9`	`9`	`*`
`10`	`10`	`* [Algorithm]`
`11`	`11`	`*`