Skip to content

Commit 78f6fac

Browse files
author
Christian Brauner
committed
sched: add kernel-doc for struct clone_args
Add kernel-doc for struct clone_args for the clone3() syscall. Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Christian Brauner <[email protected]>
1 parent 501bd01 commit 78f6fac

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

include/uapi/linux/sched.h

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,30 @@
3434
#define CLONE_IO 0x80000000 /* Clone io context */
3535

3636
#ifndef __ASSEMBLY__
37-
/*
38-
* Arguments for the clone3 syscall
37+
/**
38+
* struct clone_args - arguments for the clone3 syscall
39+
* @flags: Flags for the new process as listed above.
40+
* All flags are valid except for CSIGNAL and
41+
* CLONE_DETACHED.
42+
* @pidfd: If CLONE_PIDFD is set, a pidfd will be
43+
* returned in this argument.
44+
* @child_tid: If CLONE_CHILD_SETTID is set, the TID of the
45+
* child process will be returned in the child's
46+
* memory.
47+
* @parent_tid: If CLONE_PARENT_SETTID is set, the TID of
48+
* the child process will be returned in the
49+
* parent's memory.
50+
* @exit_signal: The exit_signal the parent process will be
51+
* sent when the child exits.
52+
* @stack: Specify the location of the stack for the
53+
* child process.
54+
* @stack_size: The size of the stack for the child process.
55+
* @tls: If CLONE_SETTLS is set, the tls descriptor
56+
* is set to tls.
57+
*
58+
* The structure is versioned by size and thus extensible.
59+
* New struct members must go at the end of the struct and
60+
* must be properly 64bit aligned.
3961
*/
4062
struct clone_args {
4163
__aligned_u64 flags;

0 commit comments

Comments
 (0)