Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Lee Jones and committed by
Greg Kroah-Hartman
08aa5042 5d5b53cf

+7 -3
+7 -3
drivers/tty/tty_io.c
··· 208 208 spin_unlock(&tty->files_lock); 209 209 } 210 210 211 - /** 211 + /* 212 212 * tty_free_file - free file->private_data 213 213 * 214 214 * This shall be used only for fail path handling when tty_add_file was not ··· 543 543 /** 544 544 * __tty_hangup - actual handler for hangup events 545 545 * @tty: tty device 546 + * @exit_session: if non-zero, signal all foreground group processes 546 547 * 547 548 * This can be called by a "kworker" kernel thread. That is process 548 549 * synchronous but doesn't hold any locks, so we need to make sure we ··· 1066 1065 return tty_write(file, buf, count, ppos); 1067 1066 } 1068 1067 1069 - /** 1068 + /* 1070 1069 * tty_send_xchar - send priority character 1071 1070 * 1072 1071 * Send a high priority character to the tty even if stopped ··· 1144 1143 /** 1145 1144 * tty_driver_lookup_tty() - find an existing tty, if any 1146 1145 * @driver: the driver for the tty 1146 + * @file: file object 1147 1147 * @idx: the minor number 1148 1148 * 1149 1149 * Return the tty, if found. If not found, return NULL or ERR_PTR() if the ··· 1496 1494 1497 1495 /** 1498 1496 * release_tty - release tty structure memory 1497 + * @tty: tty device release 1498 + * @idx: index of the tty device release 1499 1499 * 1500 1500 * Release both @tty and a possible linked partner (think pty pair), 1501 1501 * and decrement the refcount of the backing module. ··· 2965 2961 } 2966 2962 2967 2963 2968 - /** 2964 + /* 2969 2965 * alloc_tty_struct 2970 2966 * 2971 2967 * This subroutine allocates and initializes a tty structure.