Add timeout_add_sec() etc. to .Nm and, on jmc's request, tweak
authormk <mk@openbsd.org>
Thu, 24 Jul 2008 17:31:59 +0000 (17:31 +0000)
committermk <mk@openbsd.org>
Thu, 24 Jul 2008 17:31:59 +0000 (17:31 +0000)
some other stuff.

ok art jmc blambert

share/man/man9/timeout.9

index 33d42fb..10257c7 100644 (file)
@@ -1,4 +1,4 @@
-.\"    $OpenBSD: timeout.9,v 1.26 2008/07/23 11:45:21 art Exp $
+.\"    $OpenBSD: timeout.9,v 1.27 2008/07/24 17:31:59 mk Exp $
 .\"
 .\" Copyright (c) 2000 Artur Grabowski <art@openbsd.org>
 .\" All rights reserved.
 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: July 23 2008 $
+.Dd $Mdocdate: July 24 2008 $
 .Dt TIMEOUT 9
 .Os
 .Sh NAME
 .Nm timeout_set ,
 .Nm timeout_add ,
+.Nm timeout_add_sec ,
+.Nm timeout_add_nsec ,
+.Nm timeout_add_usec ,
+.Nm timeout_add_tv ,
+.Nm timeout_add_ts ,
+.Nm timeout_add_bt ,
 .Nm timeout_del ,
 .Nm timeout_pending ,
 .Nm timeout_initialized ,
@@ -158,18 +164,18 @@ and
 .Fn timeout_del
 functions clear the triggered state for that timeout.
 .Pp
-When possible, instead of using
-.Fn timeout_add
-the functions
+When possible, use the
 .Fn timeout_add_tv ,
 .Fn timeout_add_ts ,
 .Fn timeout_add_bt ,
 .Fn timeout_add_sec ,
 .Fn timeout_add_usec ,
+and
 .Fn timeout_add_nsec
-should be used.
-Those functions add a timeout doing conversion of the time specified
-by their respective types.
+functions instead of
+.Fn timeout_add .
+Those functions add a timeout whilst converting the time specified
+by the respective types.
 .Sh CODE REFERENCES
 These functions are implemented in the file
 .Pa sys/kern/kern_timeout.c .