signal: improve comments

Improve the comments for pidfd_send_signal().
First, the comment still referred to a file descriptor for a process as a
"task file descriptor" which stems from way back at the beginning of the
discussion. Replace this with "pidfd" for consistency.
Second, the wording for the explanation of the arguments to the syscall
was a bit inconsistent, e.g. some used the past tense some used present
tense. Make the wording more consistent.

Signed-off-by: Christian Brauner <christian@brauner.io>
This commit is contained in:
Christian Brauner 2019-06-04 15:18:43 +02:00
parent 7c33277b9a
commit c732327f04
No known key found for this signature in database
GPG Key ID: 8EB056D53EECB12D
1 changed files with 5 additions and 6 deletions

View File

@ -3621,12 +3621,11 @@ static struct pid *pidfd_to_pid(const struct file *file)
} }
/** /**
* sys_pidfd_send_signal - send a signal to a process through a task file * sys_pidfd_send_signal - Signal a process through a pidfd
* descriptor * @pidfd: file descriptor of the process
* @pidfd: the file descriptor of the process * @sig: signal to send
* @sig: signal to be sent * @info: signal info
* @info: the signal info * @flags: future flags
* @flags: future flags to be passed
* *
* The syscall currently only signals via PIDTYPE_PID which covers * The syscall currently only signals via PIDTYPE_PID which covers
* kill(<positive-pid>, <signal>. It does not signal threads or process * kill(<positive-pid>, <signal>. It does not signal threads or process