From: Christian Brauner <christian@brauner.io>
Date: Tue, 4 Jun 2019 13:18:43 +0000 (+0200)
Subject: signal: improve comments
X-Git-Tag: v5.2-rc4~33^2~1
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=c732327f04a3818f35fa97d07b1d64d31b691d78;p=thirdparty%2Fkernel%2Flinux.git

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>
---

diff --git a/kernel/signal.c b/kernel/signal.c
index 328a01e1a2f05..d622eac9d1693 100644
--- a/kernel/signal.c
+++ b/kernel/signal.c
@@ -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
- *                          descriptor
- * @pidfd:  the file descriptor of the process
- * @sig:    signal to be sent
- * @info:   the signal info
- * @flags:  future flags to be passed
+ * sys_pidfd_send_signal - Signal a process through a pidfd
+ * @pidfd:  file descriptor of the process
+ * @sig:    signal to send
+ * @info:   signal info
+ * @flags:  future flags
  *
  * The syscall currently only signals via PIDTYPE_PID which covers
  * kill(<positive-pid>, <signal>. It does not signal threads or process