diff options
| author | Lee Jones <lee.jones@linaro.org> | 2020-11-04 22:35:25 +0300 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2020-11-06 12:49:27 +0300 |
| commit | 08aa5042d22bb66c90e1833f2119f272863dec87 (patch) | |
| tree | e4fe7f31a4d2c0850f18dd91d80a213fcb97eeca /drivers | |
| parent | 5d5b53cf92a73d06181a366ae8160708a18e0e1c (diff) | |
| download | linux-08aa5042d22bb66c90e1833f2119f272863dec87.tar.xz | |
tty: tty_io: Fix some kernel-doc issues
Demote non-conformant headers and supply some missing descriptions.
Fixes the following W=1 kernel build warning(s):
drivers/tty/tty_io.c:218: warning: Function parameter or member 'file' not described in 'tty_free_file'
drivers/tty/tty_io.c:566: warning: Function parameter or member 'exit_session' not described in '__tty_hangup'
drivers/tty/tty_io.c:1077: warning: Function parameter or member 'tty' not described in 'tty_send_xchar'
drivers/tty/tty_io.c:1077: warning: Function parameter or member 'ch' not described in 'tty_send_xchar'
drivers/tty/tty_io.c:1155: warning: Function parameter or member 'file' not described in 'tty_driver_lookup_tty'
drivers/tty/tty_io.c:1508: warning: Function parameter or member 'tty' not described in 'release_tty'
drivers/tty/tty_io.c:1508: warning: Function parameter or member 'idx' not described in 'release_tty'
drivers/tty/tty_io.c:2973: warning: Function parameter or member 'driver' not described in 'alloc_tty_struct'
drivers/tty/tty_io.c:2973: warning: Function parameter or member 'idx' not described in 'alloc_tty_struct'
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Jiri Slaby <jirislaby@kernel.org>
Cc: Nick Holloway <alfie@dcs.warwick.ac.uk>
Cc: -- <julian@uhunix.uhcc.hawaii.edu>
Cc: Marko Kohtala <Marko.Kohtala@hut.fi>
Cc: Bill Hawes <whawes@star.net>
Cc: "C. Scott Ananian" <cananian@alumni.princeton.edu>
Cc: Russell King <rmk@arm.linux.org.uk>
Cc: Andrew Morton <andrewm@uow.edu.eu>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20201104193549.4026187-13-lee.jones@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'drivers')
| -rw-r--r-- | drivers/tty/tty_io.c | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/drivers/tty/tty_io.c b/drivers/tty/tty_io.c index 88b00c47b606..f50286fb080d 100644 --- a/drivers/tty/tty_io.c +++ b/drivers/tty/tty_io.c @@ -208,7 +208,7 @@ void tty_add_file(struct tty_struct *tty, struct file *file) spin_unlock(&tty->files_lock); } -/** +/* * tty_free_file - free file->private_data * * This shall be used only for fail path handling when tty_add_file was not @@ -543,6 +543,7 @@ EXPORT_SYMBOL_GPL(tty_wakeup); /** * __tty_hangup - actual handler for hangup events * @tty: tty device + * @exit_session: if non-zero, signal all foreground group processes * * This can be called by a "kworker" kernel thread. That is process * synchronous but doesn't hold any locks, so we need to make sure we @@ -1065,7 +1066,7 @@ ssize_t redirected_tty_write(struct file *file, const char __user *buf, return tty_write(file, buf, count, ppos); } -/** +/* * tty_send_xchar - send priority character * * Send a high priority character to the tty even if stopped @@ -1143,6 +1144,7 @@ static ssize_t tty_line_name(struct tty_driver *driver, int index, char *p) /** * tty_driver_lookup_tty() - find an existing tty, if any * @driver: the driver for the tty + * @file: file object * @idx: the minor number * * Return the tty, if found. If not found, return NULL or ERR_PTR() if the @@ -1494,6 +1496,8 @@ EXPORT_SYMBOL(tty_kref_put); /** * release_tty - release tty structure memory + * @tty: tty device release + * @idx: index of the tty device release * * Release both @tty and a possible linked partner (think pty pair), * and decrement the refcount of the backing module. @@ -2961,7 +2965,7 @@ static struct device *tty_get_device(struct tty_struct *tty) } -/** +/* * alloc_tty_struct * * This subroutine allocates and initializes a tty structure. |