[PATCH 03/11] tty: tty_io: Fix a few kernel-doc related misdemeanours

From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Jiri Slaby <jirislaby@kernel.org>,
	Nick Holloway <alfie@dcs.warwick.ac.uk>,
	-- <julian@uhunix.uhcc.hawaii.edu>,
	Marko Kohtala <Marko.Kohtala@hut.fi>,
	Bill Hawes <whawes@star.net>,
	"C. Scott Ananian" <cananian@alumni.princeton.edu>,
	Russell King <rmk@arm.linux.org.uk>,
	Andrew Morton <andrewm@uow.edu.eu>
Subject: [PATCH 03/11] tty: tty_io: Fix a few kernel-doc related misdemeanours
Date: Thu, 20 May 2021 13:18:58 +0100	[thread overview]
Message-ID: <20210520121906.3468725-4-lee.jones@linaro.org> (raw)
In-Reply-To: <20210520121906.3468725-1-lee.jones@linaro.org>

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

 drivers/tty/tty_io.c:785: warning: expecting prototype for stop_tty(). Prototype was for __stop_tty() instead
 drivers/tty/tty_io.c:816: warning: expecting prototype for start_tty(). Prototype was for __start_tty() instead
 drivers/tty/tty_io.c:931: warning: Function parameter or member 'iocb' not described in 'tty_read'
 drivers/tty/tty_io.c:931: warning: Function parameter or member 'to' not described in 'tty_read'
 drivers/tty/tty_io.c:931: warning: Excess function parameter 'file' description in 'tty_read'
 drivers/tty/tty_io.c:931: warning: Excess function parameter 'buf' description in 'tty_read'
 drivers/tty/tty_io.c:931: warning: Excess function parameter 'count' description in 'tty_read'
 drivers/tty/tty_io.c:931: warning: Excess function parameter 'ppos' description in 'tty_read'
 drivers/tty/tty_io.c:1115: warning: Function parameter or member 'iocb' not described in 'file_tty_write'
 drivers/tty/tty_io.c:1115: warning: Function parameter or member 'from' not described in 'file_tty_write'
 drivers/tty/tty_io.c:1115: warning: expecting prototype for tty_write(). Prototype was for file_tty_write() instead

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>
---
 drivers/tty/tty_io.c | 15 ++++-----------
 1 file changed, 4 insertions(+), 11 deletions(-)

diff --git a/drivers/tty/tty_io.c b/drivers/tty/tty_io.c
index 8f9e89715a68e..defea9cc20ce9 100644
--- a/drivers/tty/tty_io.c
+++ b/drivers/tty/tty_io.c
@@ -762,7 +762,7 @@ int tty_hung_up_p(struct file *filp)
 EXPORT_SYMBOL(tty_hung_up_p);
 
 /**
- *	stop_tty	-	propagate flow control
+ *	__stop_tty	-	propagate flow control
  *	@tty: tty to stop
  *
  *	Perform flow control to the driver. May be called
@@ -798,7 +798,7 @@ void stop_tty(struct tty_struct *tty)
 EXPORT_SYMBOL(stop_tty);
 
 /**
- *	start_tty	-	propagate flow control
+ *	__start_tty	-	propagate flow control
  *	@tty: tty to start
  *
  *	Start a tty that has been stopped if at all possible. If this
@@ -909,12 +909,8 @@ static int iterate_tty_read(struct tty_ldisc *ld, struct tty_struct *tty,
 }
 
 
-/**
+/*
  *	tty_read	-	read method for tty device files
- *	@file: pointer to tty file
- *	@buf: user buffer
- *	@count: size of user buffer
- *	@ppos: unused
  *
  *	Perform the read system call function on this terminal device. Checks
  *	for hung up devices before calling the line discipline method.
@@ -1093,12 +1089,9 @@ void tty_write_message(struct tty_struct *tty, char *msg)
 }
 
 
-/**
+/*
  *	tty_write		-	write method for tty device file
  *	@file: tty file pointer
- *	@buf: user data to write
- *	@count: bytes to write
- *	@ppos: unused
  *
  *	Write data to a tty device via the line discipline.
  *
-- 
2.31.1

