Documentation revision for TCP_USER_TIMEOUT in man7/tcp7

Documentation revision for TCP_USER_TIMEOUT in man7/tcp7

[Enke Chen]

diff --git a/man7/tcp.7 b/man7/tcp.7
index 6c91f058b..2ce831c90 100644
--- a/man7/tcp.7
+++ b/man7/tcp.7
@@ -1161,7 +1161,8 @@ This option takes an
 as an argument.
 When the value is greater than 0,
 it specifies the maximum amount of time in milliseconds that transmitted
-data may remain unacknowledged before TCP will forcibly close the
+data may remain unacknowledged, or bufferred data may remain untransmitted
+(due to zero window size) before TCP will forcibly close the
 corresponding connection and return
 .B ETIMEDOUT
 to the application.

Re: Documentation revision for TCP_USER_TIMEOUT in man7/tcp7

[Michael Kerrisk (man-pages)]

Hello Enke (and Eric),

Thank you for the patch. Is this a change in behavior, or a better
documentation of longstanding behavior?

Eric, do you have an Ack/Review for this patch?

Thanks,

Michael

On Sat, 9 Jan 2021 at 06:21, Enke Chen <enkechen2020@gmail.com> wrote:
>
> diff --git a/man7/tcp.7 b/man7/tcp.7
> index 6c91f058b..2ce831c90 100644
> --- a/man7/tcp.7
> +++ b/man7/tcp.7
> @@ -1161,7 +1161,8 @@ This option takes an
>  as an argument.
>  When the value is greater than 0,
>  it specifies the maximum amount of time in milliseconds that transmitted
> -data may remain unacknowledged before TCP will forcibly close the
> +data may remain unacknowledged, or bufferred data may remain untransmitted
> +(due to zero window size) before TCP will forcibly close the
>  corresponding connection and return
>  .B ETIMEDOUT
>  to the application.



-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/

Re: Documentation revision for TCP_USER_TIMEOUT in man7/tcp7

[Enke Chen]

Hello Michael:

It is the latter, better documentation of longstanding behavior.

There is a bug, however, that broke the functionality two years ago.
The bug is being fixed.

Thanks.  -- Enke

On Thu, Jan 14, 2021 at 01:08:26PM +0100, Michael Kerrisk (man-pages) wrote:
> Hello Enke (and Eric),
> 
> Thank you for the patch. Is this a change in behavior, or a better
> documentation of longstanding behavior?
> 
> Eric, do you have an Ack/Review for this patch?
> 
> Thanks,
> 
> Michael
> 
> On Sat, 9 Jan 2021 at 06:21, Enke Chen <enkechen2020@gmail.com> wrote:
> >
> > diff --git a/man7/tcp.7 b/man7/tcp.7
> > index 6c91f058b..2ce831c90 100644
> > --- a/man7/tcp.7
> > +++ b/man7/tcp.7
> > @@ -1161,7 +1161,8 @@ This option takes an
> >  as an argument.
> >  When the value is greater than 0,
> >  it specifies the maximum amount of time in milliseconds that transmitted
> > -data may remain unacknowledged before TCP will forcibly close the
> > +data may remain unacknowledged, or bufferred data may remain untransmitted
> > +(due to zero window size) before TCP will forcibly close the
> >  corresponding connection and return
> >  .B ETIMEDOUT
> >  to the application.
> 
> 
> 
> -- 
> Michael Kerrisk
> Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
> Linux/UNIX System Programming Training: http://man7.org/training/

Re: Documentation revision for TCP_USER_TIMEOUT in man7/tcp7

[Michael Kerrisk (man-pages)]

On 1/14/21 8:27 PM, Enke Chen wrote:
> Hello Michael:
> 
> It is the latter, better documentation of longstanding behavior.
> 
> There is a bug, however, that broke the functionality two years ago.
> The bug is being fixed.

Thanks for the info, Enke. I've applied the patch.

Cheers,

Michael

> On Thu, Jan 14, 2021 at 01:08:26PM +0100, Michael Kerrisk (man-pages) wrote:
>> Hello Enke (and Eric),
>>
>> Thank you for the patch. Is this a change in behavior, or a better
>> documentation of longstanding behavior?
>>
>> Eric, do you have an Ack/Review for this patch?
>>
>> Thanks,
>>
>> Michael
>>
>> On Sat, 9 Jan 2021 at 06:21, Enke Chen <enkechen2020@gmail.com> wrote:
>>>
>>> diff --git a/man7/tcp.7 b/man7/tcp.7
>>> index 6c91f058b..2ce831c90 100644
>>> --- a/man7/tcp.7
>>> +++ b/man7/tcp.7
>>> @@ -1161,7 +1161,8 @@ This option takes an
>>>  as an argument.
>>>  When the value is greater than 0,
>>>  it specifies the maximum amount of time in milliseconds that transmitted
>>> -data may remain unacknowledged before TCP will forcibly close the
>>> +data may remain unacknowledged, or bufferred data may remain untransmitted
>>> +(due to zero window size) before TCP will forcibly close the
>>>  corresponding connection and return
>>>  .B ETIMEDOUT
>>>  to the application.
>>
>>
>>
>> -- 
>> Michael Kerrisk
>> Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
>> Linux/UNIX System Programming Training: http://man7.org/training/


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/