diff options
author | Christian Brauner <christian.brauner@ubuntu.com> | 2019-09-27 17:29:05 +0200 |
---|---|---|
committer | Christian Brauner <christian.brauner@ubuntu.com> | 2019-10-03 21:19:29 +0200 |
commit | 78f6face5af344f12f4bd48b32faa6f499a06f36 (patch) | |
tree | a4ac47928335da1b21b30d921b219efb73fae78f /include | |
parent | 501bd0166eb949820c8e4204e62aaee5c89c84d9 (diff) | |
download | linux-78f6face5af344f12f4bd48b32faa6f499a06f36.tar.bz2 |
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/20191001114701.24661-3-christian.brauner@ubuntu.com
Signed-off-by: Christian Brauner <christian.brauner@ubuntu.com>
Diffstat (limited to 'include')
-rw-r--r-- | include/uapi/linux/sched.h | 26 |
1 files changed, 24 insertions, 2 deletions
diff --git a/include/uapi/linux/sched.h b/include/uapi/linux/sched.h index 851ff1feadd5..3d8f03bfd428 100644 --- a/include/uapi/linux/sched.h +++ b/include/uapi/linux/sched.h @@ -34,8 +34,30 @@ #define CLONE_IO 0x80000000 /* Clone io context */ #ifndef __ASSEMBLY__ -/* - * Arguments for the clone3 syscall +/** + * struct clone_args - arguments for the clone3 syscall + * @flags: Flags for the new process as listed above. + * All flags are valid except for CSIGNAL and + * CLONE_DETACHED. + * @pidfd: If CLONE_PIDFD is set, a pidfd will be + * returned in this argument. + * @child_tid: If CLONE_CHILD_SETTID is set, the TID of the + * child process will be returned in the child's + * memory. + * @parent_tid: If CLONE_PARENT_SETTID is set, the TID of + * the child process will be returned in the + * parent's memory. + * @exit_signal: The exit_signal the parent process will be + * sent when the child exits. + * @stack: Specify the location of the stack for the + * child process. + * @stack_size: The size of the stack for the child process. + * @tls: If CLONE_SETTLS is set, the tls descriptor + * is set to tls. + * + * The structure is versioned by size and thus extensible. + * New struct members must go at the end of the struct and + * must be properly 64bit aligned. */ struct clone_args { __aligned_u64 flags; |