Re: timeout.9: fix description

2022-07-22 Thread Klemens Nanni
On Fri, Jul 22, 2022 at 06:16:35AM -0500, Scott Cheloha wrote:
> I rewrote this page a year or so ago but I
> think I dropped the patch due to lack of
> developer input.  If you give me 12 hours I
> will send it out for your consideration.

Sure, no hurry, I'll look at it.

> I would send it sooner, but I accidentally cut
> the fiber-optic cable with a shovel last night,
> so we all need to wait until this afternoon for
> AT&T to replace it.

Just don't dig your own grave!



Re: timeout.9: fix description

2022-07-22 Thread Scott Cheloha
> On Jul 22, 2022, at 05:50, Klemens Nanni  wrote:
> 
> NAME has it right:
>... – execute a function after a specified period of time
> 
> but DESCRIPTION says something else:
>The timeout API provides a mechanism to execute a function
>at a given time.
> 
> The latter reads as if I could pass a specific point in time, e.g.
> Fri Jul 22 16:00:00 UTC 2022, at which a function should be run.
> 
> But this API is about timeouts, i.e. a duration of time like 10s,
> which does not my understanding of "at a given time".
> 
> 
> So reuse NAME's wording and make it a proper sentence.
> 
> Feedback? OK?

I rewrote this page a year or so ago but I
think I dropped the patch due to lack of
developer input.  If you give me 12 hours I
will send it out for your consideration.

I would send it sooner, but I accidentally cut
the fiber-optic cable with a shovel last night,
so we all need to wait until this afternoon for
AT&T to replace it.



timeout.9: fix description

2022-07-22 Thread Klemens Nanni
NAME has it right:
... – execute a function after a specified period of time

but DESCRIPTION says something else:
The timeout API provides a mechanism to execute a function
at a given time.

The latter reads as if I could pass a specific point in time, e.g.
Fri Jul 22 16:00:00 UTC 2022, at which a function should be run.

But this API is about timeouts, i.e. a duration of time like 10s,
which does not my understanding of "at a given time".


So reuse NAME's wording and make it a proper sentence.

Feedback? OK?

Index: timeout.9
===
RCS file: /cvs/src/share/man/man9/timeout.9,v
retrieving revision 1.55
diff -u -p -r1.55 timeout.9
--- timeout.9   22 Jun 2022 14:10:49 -  1.55
+++ timeout.9   22 Jul 2022 10:41:54 -
@@ -88,7 +88,8 @@
 .Sh DESCRIPTION
 The
 .Nm timeout
-API provides a mechanism to execute a function at a given time.
+API provides a mechanism to execute a function after a specified period of
+time has elapsed.
 The granularity of the time is limited by the granularity of the
 .Xr hardclock 9
 timer which executes