LKML Archive mirror
 help / color / mirror / Atom feed
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


  parent reply	other threads:[~2021-05-20 12:54 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-20 12:18 [PATCH 00/11] Rid W=1 warnings from TTY Lee Jones
2021-05-20 12:18 ` [PATCH 01/11] tty: vt: selection: Correct misspelled function sel_loadlut() Lee Jones
2021-05-20 12:18 ` [PATCH 02/11] tty: serdev: core: Fix misspelled function name __serdev_device_driver_register() Lee Jones
2021-05-20 12:18 ` Lee Jones [this message]
2021-05-20 12:18 ` [PATCH 04/11] tty: n_tty: Fix some misdocumented functions Lee Jones
2021-05-20 12:19 ` [PATCH 05/11] tty: tty_buffer: Fix incorrectly documented function __tty_buffer_request_room() Lee Jones
2021-05-20 12:19 ` [PATCH 06/11] tty: tty_jobctrl: Fix 2 incorrectly documented functions Lee Jones
2021-05-20 12:19 ` [PATCH 07/11] tty: pty: Fix incorrectly named function pty_resize() Lee Jones
2021-05-20 12:19 ` [PATCH 08/11] tty: n_hdlc: Fix a little doc-rot in n_hdlc_tty_read() Lee Jones
2021-05-20 12:19 ` [PATCH 09/11] tty: serial: st-asc: Demote a kernel-doc formatting abuse Lee Jones
2021-05-20 12:19 ` [PATCH 10/11] tty: n_gsm: Fix function naming and provide missing param descriptions Lee Jones
2021-05-20 12:19 ` [PATCH 11/11] tty: serial: xilinx_uartps: Fix documentation for cdns_uart_clk_notifier_cb() Lee Jones
2021-05-20 12:21   ` Michal Simek
2021-05-20 15:07 ` [PATCH 00/11] Rid W=1 warnings from TTY Greg Kroah-Hartman

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210520121906.3468725-4-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=Marko.Kohtala@hut.fi \
    --cc=alfie@dcs.warwick.ac.uk \
    --cc=andrewm@uow.edu.eu \
    --cc=cananian@alumni.princeton.edu \
    --cc=gregkh@linuxfoundation.org \
    --cc=jirislaby@kernel.org \
    --cc=julian@uhunix.uhcc.hawaii.edu \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rmk@arm.linux.org.uk \
    --cc=whawes@star.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).