linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Simon Arlott <simon@octiron.net>
To: Jiri Slaby <jirislaby@kernel.org>,
	Oliver Neukum <oneukum@suse.com>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: linux-kernel@vger.kernel.org, linux-usb@vger.kernel.org,
	linux-serial@vger.kernel.org
Subject: [PATCH (v2)] docs: ABI: sysfs-tty: close times are in centiseconds
Date: Sun, 27 Aug 2023 19:23:39 +0100	[thread overview]
Message-ID: <30fa035a-709f-58cd-fc1e-fef1367dc6dd@0882a8b5-c6c3-11e9-b005-00805fc181fe.uuid.home.arpa> (raw)
In-Reply-To: <2a3647bf-91a8-7a5f-9edb-c792a6031f57@kernel.org>

The times for close_delay and closing_wait are in centiseconds, not
milliseconds. Fix the documentation and add details of special values.

Signed-off-by: Simon Arlott <simon@octiron.net>
---
On 25/08/2023 06:33, Jiri Slaby wrote:
> And I would use "centiseconds" instead, which is used (IMO) in these cases.

It's used in a few places, but the documentation has no "centiseconds"
and a couple of "hundredths". I've changed it anyway.

 Documentation/ABI/testing/sysfs-tty | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-tty b/Documentation/ABI/testing/sysfs-tty
index 820e412d38a8..895c47f05f6f 100644
--- a/Documentation/ABI/testing/sysfs-tty
+++ b/Documentation/ABI/testing/sysfs-tty
@@ -87,19 +87,22 @@ What:		/sys/class/tty/ttyS<x>/close_delay
 Date:		October 2012
 Contact:	Alan Cox <alan@linux.intel.com>
 Description:
-		 Show the closing delay time for this port in ms.
+		Show the closing delay time for this port in centiseconds.
 
-		 These sysfs values expose the TIOCGSERIAL interface via
-		 sysfs rather than via ioctls.
+		These sysfs values expose the TIOCGSERIAL interface via
+		sysfs rather than via ioctls.
 
 What:		/sys/class/tty/ttyS<x>/closing_wait
 Date:		October 2012
 Contact:	Alan Cox <alan@linux.intel.com>
 Description:
-		 Show the close wait time for this port in ms.
+		Show the close wait time for this port in centiseconds.
 
-		 These sysfs values expose the TIOCGSERIAL interface via
-		 sysfs rather than via ioctls.
+		Waiting forever is represented as 0. If waiting on close is
+		disabled then the value is 65535.
+
+		These sysfs values expose the TIOCGSERIAL interface via
+		sysfs rather than via ioctls.
 
 What:		/sys/class/tty/ttyS<x>/custom_divisor
 Date:		October 2012
-- 
2.37.0

-- 
Simon Arlott


  reply	other threads:[~2023-08-27 18:25 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-08-23 20:37 [PATCH] USB: cdc-acm: expose serial close_delay and closing_wait in sysfs Simon Arlott
2023-08-23 21:12 ` [PATCH (v2)] " Simon Arlott
2023-08-24  7:18   ` [PATCH] docs: ABI: sysfs-tty: close times are in hundredths of a second Simon Arlott
2023-08-25  5:33     ` Jiri Slaby
2023-08-27 18:23       ` Simon Arlott [this message]
2023-08-24  8:21 ` [PATCH] USB: cdc-acm: expose serial close_delay and closing_wait in sysfs Oliver Neukum
2023-08-24 14:48 ` Greg Kroah-Hartman
2023-08-24 18:02   ` Simon Arlott
2023-08-24 19:22     ` Greg Kroah-Hartman
2023-08-27 15:36       ` Simon Arlott
2023-08-24 23:46     ` Oliver Neukum
2023-08-25  1:53       ` Alan Stern

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=30fa035a-709f-58cd-fc1e-fef1367dc6dd@0882a8b5-c6c3-11e9-b005-00805fc181fe.uuid.home.arpa \
    --to=simon@octiron.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=jirislaby@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-serial@vger.kernel.org \
    --cc=linux-usb@vger.kernel.org \
    --cc=oneukum@suse.com \
    /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).