Kernel/linux
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2025-01-10 15:19:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

tty: tty_ldisc: Fix some kernel-doc related misdemeanours

Browse Source 
- Functions must follow directly on from their headers
 - Demote non-conforming kernel-doc header
 - Ensure notes have unique section names
 - Provide missing description for 'reinit'

Fixes the following W=1 kernel build warning(s):

 drivers/tty/tty_ldisc.c:158: warning: cannot understand function prototype: 'int tty_ldisc_autoload = IS_BUILTIN(CONFIG_LDISC_AUTOLOAD); '
 drivers/tty/tty_ldisc.c:199: warning: Function parameter or member 'ld' not described in 'tty_ldisc_put'
 drivers/tty/tty_ldisc.c:260: warning: duplicate section name 'Note'
 drivers/tty/tty_ldisc.c:717: warning: Function parameter or member 'reinit' not described in 'tty_ldisc_hangup'

Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Jiri Slaby <jirislaby@kernel.org>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20201112105857.2078977-2-lee.jones@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Lee Jones 2020-11-12 10:58:54 +00:00 committed by Greg Kroah-Hartman
parent bc0468ee49
commit 8eddcca2a7
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
drivers/tty/tty_ldisc.c
View File

@ -135,6 +135,7 @@ static void put_ldops(struct tty_ldisc_ops *ldops)
raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags); raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
} }
static int tty_ldisc_autoload = IS_BUILTIN(CONFIG_LDISC_AUTOLOAD);
/** /**
* tty_ldisc_get - take a reference to an ldisc * tty_ldisc_get - take a reference to an ldisc
* @tty: tty device * @tty: tty device
@ -156,8 +157,6 @@ static void put_ldops(struct tty_ldisc_ops *ldops)
* takes tty_ldiscs_lock to guard against ldisc races * takes tty_ldiscs_lock to guard against ldisc races
*/ */
static int tty_ldisc_autoload = IS_BUILTIN(CONFIG_LDISC_AUTOLOAD);
static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc) static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc)
{ {
struct tty_ldisc *ld; struct tty_ldisc *ld;
@ -191,7 +190,7 @@ static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc)
return ld; return ld;
} }
/** /*
* tty_ldisc_put - release the ldisc * tty_ldisc_put - release the ldisc
* *
* Complement of tty_ldisc_get(). * Complement of tty_ldisc_get().
@ -251,12 +250,12 @@ const struct seq_operations tty_ldiscs_seq_ops = {
* Returns: NULL if the tty has been hungup and not re-opened with * Returns: NULL if the tty has been hungup and not re-opened with
* a new file descriptor, otherwise valid ldisc reference * a new file descriptor, otherwise valid ldisc reference
* *
* Note: Must not be called from an IRQ/timer context. The caller * Note 1: Must not be called from an IRQ/timer context. The caller
* must also be careful not to hold other locks that will deadlock * must also be careful not to hold other locks that will deadlock
* against a discipline change, such as an existing ldisc reference * against a discipline change, such as an existing ldisc reference
* (which we check for) * (which we check for)
* *
* Note: a file_operations routine (read/poll/write) should use this * Note 2: a file_operations routine (read/poll/write) should use this
* function to wait for any ldisc lifetime events to finish. * function to wait for any ldisc lifetime events to finish.
*/ */
@ -702,6 +701,7 @@ int tty_ldisc_reinit(struct tty_struct *tty, int disc)
/** /**
* tty_ldisc_hangup - hangup ldisc reset * tty_ldisc_hangup - hangup ldisc reset
* @tty: tty being hung up * @tty: tty being hung up
* @reinit: whether to re-initialise the tty
* *
* Some tty devices reset their termios when they receive a hangup * Some tty devices reset their termios when they receive a hangup
* event. In that situation we must also switch back to N_TTY properly * event. In that situation we must also switch back to N_TTY properly