ualarm.3: cleanups, rewrites
authorcheloha <cheloha@openbsd.org>
Tue, 1 Aug 2023 01:17:25 +0000 (01:17 +0000)
committercheloha <cheloha@openbsd.org>
Tue, 1 Aug 2023 01:17:25 +0000 (01:17 +0000)
commit4539d4267463fba5637c7c8a01f2dd4fe6cc901a
tree4cad7eaaf559652e83d9f46a50983d954f22f169
parent758370f9b4b9ae70cbde195e176612bb0bacfcde
ualarm.3: cleanups, rewrites

Clean up the ualarm.3 page as we did with the alarm.3 page.

- Be more specific in the Name summary.
- Rewrite the Description.  In particular, ualarm(3) does not block,
  it schedules the signal for asynchronous delivery.
- The Return Values section is incoherent, rewrite it.  Remove the
  incorrect details about the upper bound.
- Add Caveats: discourage use of ualarm(3) and setitimer(2) in the
  same program.

Input on v1 from schwarze@, deraadt@, millert@, and jmc@.  Input on v2
from jmc@ and millert@.

v1: https://marc.info/?l=openbsd-tech&m=162508423008134&w=2
v2: https://marc.info/?l=openbsd-tech&m=169076642509763&w=2

ok jmc@ millert@
lib/libc/gen/ualarm.3