From: "Jiri Slaby (SUSE)" <jirislaby@kernel.org>
To: gregkh@linuxfoundation.org
Cc: linux-serial@vger.kernel.org, linux-kernel@vger.kernel.org,
	"Jiri Slaby (SUSE)" <jirislaby@kernel.org>
Subject: [PATCH 03/17] tty: fix tty_operations types in documentation
Date: Tue, 21 Nov 2023 10:22:44 +0100	[thread overview]
Message-ID: <20231121092258.9334-4-jirislaby@kernel.org> (raw)
In-Reply-To: <20231121092258.9334-1-jirislaby@kernel.org>
Commits 95713967ba52 ("tty: make tty_operations::write()'s count
size_t") and dcaafbe6ee3b ("tty: propagate u8 data to
tty_operations::put_char()") changed types of characters to u8, but
omitted to fix the documentation.
Fix the latter now.
Signed-off-by: Jiri Slaby (SUSE) <jirislaby@kernel.org>
---
 include/linux/tty_driver.h | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/include/linux/tty_driver.h b/include/linux/tty_driver.h
index 18beff0cec1a..f428c1b784a2 100644
--- a/include/linux/tty_driver.h
+++ b/include/linux/tty_driver.h
@@ -72,8 +72,7 @@ struct serial_struct;
  *	is closed for the last time freeing up the resources. This is
  *	actually the second part of shutdown for routines that might sleep.
  *
- * @write: ``ssize_t ()(struct tty_struct *tty, const unsigned char *buf,
- *		    size_t count)``
+ * @write: ``ssize_t ()(struct tty_struct *tty, const u8 *buf, size_t count)``
  *
  *	This routine is called by the kernel to write a series (@count) of
  *	characters (@buf) to the @tty device. The characters may come from
@@ -85,7 +84,7 @@ struct serial_struct;
  *
  *	Optional: Required for writable devices. May not sleep.
  *
- * @put_char: ``int ()(struct tty_struct *tty, unsigned char ch)``
+ * @put_char: ``int ()(struct tty_struct *tty, u8 ch)``
  *
  *	This routine is called by the kernel to write a single character @ch to
  *	the @tty device. If the kernel uses this routine, it must call the
-- 
2.42.1
next prev parent reply	other threads:[~2023-11-21  9:23 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-11-21  9:22 [PATCH 00/17] tty: small cleanups and fixes Jiri Slaby (SUSE)
2023-11-21  9:22 ` [PATCH 01/17] tty: deprecate tty_write_message() Jiri Slaby (SUSE)
2023-11-21 14:41   ` Jan Kara
2023-11-21  9:22 ` [PATCH 02/17] tty: remove unneeded mbz from tiocsti() Jiri Slaby (SUSE)
2023-11-21  9:22 ` Jiri Slaby (SUSE) [this message]
2023-11-21  9:22 ` [PATCH 04/17] tty: move locking docs out of Returns for functions in tty.h Jiri Slaby (SUSE)
2023-11-21  9:48   ` Ilpo Järvinen
2023-11-22  6:45     ` Jiri Slaby
2023-11-22  6:53       ` Jiri Slaby
2023-11-22 10:26         ` Ilpo Järvinen
2023-11-21  9:22 ` [PATCH 05/17] tty: amiserial: return from receive_chars() without goto Jiri Slaby (SUSE)
2023-11-21  9:22 ` [PATCH 06/17] tty: amiserial: use bool and rename overrun flag in receive_chars() Jiri Slaby (SUSE)
2023-11-21  9:22 ` [PATCH 07/17] tty: ehv_bytecha: use memcpy_and_pad() in local_ev_byte_channel_send() Jiri Slaby (SUSE)
2023-11-21  9:22 ` [PATCH 08/17] tty: goldfish: drop unneeded temporary variables Jiri Slaby (SUSE)
2023-11-21  9:22 ` [PATCH 09/17] tty: hso: don't emit load/unload info to the log Jiri Slaby (SUSE)
2023-11-21 22:30   ` Jakub Kicinski
2023-11-21  9:22 ` [PATCH 10/17] tty: hso: don't initialize global serial_table Jiri Slaby (SUSE)
2023-11-21 22:30   ` Jakub Kicinski
2023-11-21  9:22 ` [PATCH 11/17] tty: hvc_console: use flexible array for outbuf Jiri Slaby (SUSE)
2023-11-21  9:22 ` [PATCH 12/17] tty: nozomi: remove unused debugging DUMP() Jiri Slaby (SUSE)
2023-11-21  9:22 ` [PATCH 13/17] tty: srmcons: use 'buf' directly in srmcons_do_write() Jiri Slaby (SUSE)
2023-11-21 17:47   ` Richard Henderson
2023-11-21  9:22 ` [PATCH 14/17] tty: srmcons: use 'count' " Jiri Slaby (SUSE)
2023-11-21 15:21   ` Ilpo Järvinen
2023-11-21 17:48     ` Richard Henderson
2023-11-22  6:26       ` Jiri Slaby
2023-11-21  9:22 ` [PATCH 15/17] tty: srmcons: make srmcons_do_write() return void Jiri Slaby (SUSE)
2023-11-21 17:48   ` Richard Henderson
2023-11-21  9:22 ` [PATCH 16/17] tty: srmcons: switch need_cr to bool Jiri Slaby (SUSE)
2023-11-21 17:49   ` Richard Henderson
2023-11-21  9:22 ` [PATCH 17/17] tty: srmcons: make 'str_cr' const and non-array Jiri Slaby (SUSE)
2023-11-21 15:28   ` Ilpo Järvinen
2023-11-22  6:32     ` Jiri Slaby
2023-11-21 17:52   ` Richard Henderson
2023-11-21 17:58   ` Richard Henderson
2023-11-23 20:19 ` [PATCH 00/17] tty: small cleanups and fixes Greg KH
2023-11-27  9:30   ` Jiri Slaby
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=20231121092258.9334-4-jirislaby@kernel.org \
    --to=jirislaby@kernel.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-serial@vger.kernel.org \
    /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 NNTP newsgroup(s).