From: "Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>
To: Jiri Slaby <jirislaby@kernel.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
linux-serial <linux-serial@vger.kernel.org>,
LKML <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH 04/17] tty: move locking docs out of Returns for functions in tty.h
Date: Wed, 22 Nov 2023 12:26:55 +0200 (EET) [thread overview]
Message-ID: <46ef4b89-6a6b-ddb1-fec8-eb9749e9b0f3@linux.intel.com> (raw)
In-Reply-To: <ce8e5446-9fcf-4692-90e5-1c5fa75a880f@kernel.org>
[-- Attachment #1: Type: text/plain, Size: 2499 bytes --]
On Wed, 22 Nov 2023, Jiri Slaby wrote:
> On 22. 11. 23, 7:45, Jiri Slaby wrote:
> > On 21. 11. 23, 10:48, Ilpo Järvinen wrote:
> > > On Tue, 21 Nov 2023, Jiri Slaby (SUSE) wrote:
> > >
> > > > Both tty_kref_get() and tty_get_baud_rate() note about locking in their
> > > > Return kernel-doc clause. Extract this info into a separate "Locking"
> > > > paragraph -- the same as we do for other tty functions.
> > > >
> > > > Signed-off-by: Jiri Slaby (SUSE) <jirislaby@kernel.org>
> > > > Suggested-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
> > > > ---
> > > > include/linux/tty.h | 12 +++++++-----
> > > > 1 file changed, 7 insertions(+), 5 deletions(-)
> > > >
> > > > diff --git a/include/linux/tty.h b/include/linux/tty.h
> > > > index 4b6340ac2af2..7625fc98fef3 100644
> > > > --- a/include/linux/tty.h
> > > > +++ b/include/linux/tty.h
> > ...
> > > > @@ -436,10 +438,10 @@ void tty_encode_baud_rate(struct tty_struct *tty,
> > > > speed_t ibaud,
> > > > * tty_get_baud_rate - get tty bit rates
> > > > * @tty: tty to query
> > > > *
> > > > - * Returns: the baud rate as an integer for this terminal. The termios
> > > > lock
> > > > - * must be held by the caller and the terminal bit flags may be
> > > > updated.
> > > > + * Returns: the baud rate as an integer for this terminal
> > > > *
> > > > - * Locking: none
> > > > + * Locking: The termios lock must be held by the caller and the
> > > > terminal bit
> > > > + * flags may be updated.
> > >
> > > I don't think the second part about the flags really belongs here, I'd
> > > keep it the description.
> >
> > Any idea what does the part says in fact? I had not been thinking about the
> > content and now I don't understand it.
>
> Maybe before:
> commit 6865ff222ccab371c04afce17aec1f7d70b17dbc
> Author: Jiri Slaby <jirislaby@kernel.org>
> Date: Thu Mar 7 13:12:27 2013 +0100
>
> TTY: do not warn about setting speed via SPD_*
>
>
> tty->warned was "the terminal bit".
>
> Let's drop that part. And we can make tty const there too.
Good point.
The commit you point to is probably unrelated though but thanks anyway
because it gave me this idea which I think is the correct reference: I
removed the ->c_cflag alteringin 87888fb9ac0c ("tty: Remove baudrate dead
code & make ktermios params const"). It had become deadcode anyway long
since (I never went through the arch headers to find how long ago).
So yes, dropping the second part seems the correct way to go.
--
i.
next prev parent reply other threads:[~2023-11-22 10:27 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 ` [PATCH 03/17] tty: fix tty_operations types in documentation Jiri Slaby (SUSE)
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 [this message]
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=46ef4b89-6a6b-ddb1-fec8-eb9749e9b0f3@linux.intel.com \
--to=ilpo.jarvinen@linux.intel.com \
--cc=gregkh@linuxfoundation.org \
--cc=jirislaby@kernel.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 read-only IMAP folder(s) and NNTP newsgroup(s).