tvtohz() was split into tvtohz_low() and tvtohz_high() in Jan 2004.
authorSascha Wildner <swildner@dragonflybsd.org>
Sat, 30 Jun 2007 21:47:54 +0000 (21:47 +0000)
committerSascha Wildner <swildner@dragonflybsd.org>
Sat, 30 Jun 2007 21:47:54 +0000 (21:47 +0000)
Update the manual page with some words from the comments in kern_clock.c.

share/man/man9/Makefile
share/man/man9/tvtohz.9

index b96fcd0..60e5ffd 100644 (file)
@@ -1,5 +1,5 @@
 # $FreeBSD: src/share/man/man9/Makefile,v 1.60.2.26 2003/06/13 01:04:17 hmp Exp $
-# $DragonFly: src/share/man/man9/Makefile,v 1.54 2007/05/27 16:07:41 swildner Exp $
+# $DragonFly: src/share/man/man9/Makefile,v 1.55 2007/06/30 21:47:54 swildner Exp $
 
 MAN=   accept_filter.9 \
        accf_data.9 \
@@ -485,6 +485,8 @@ MLINKS+=timeout.9 callout.9 \
        timeout.9 callout_reset.9 \
        timeout.9 callout_stop.9 \
        timeout.9 untimeout.9
+MLINKS+=tvtohz.9 tvtohz_high.9 \
+       tvtohz.9 tvtohz_low.9
 MLINKS+=uio.9 uiomove.9
 MLINKS+=vhold.9 vdrop.9
 MLINKS+=VOP_ATTRIB.9 VOP_GETATTR.9 \
index ac52d1b..40b9d73 100644 (file)
 .\" SUCH DAMAGE.
 .\"
 .\"    $FreeBSD: src/share/man/man9/tvtohz.9,v 1.1.4.2 2001/12/17 11:30:19 ru Exp $
-.\"    $DragonFly: src/share/man/man9/tvtohz.9,v 1.2 2003/06/17 04:37:01 dillon Exp $
+.\"    $DragonFly: src/share/man/man9/tvtohz.9,v 1.3 2007/06/30 21:47:54 swildner Exp $
 .\"
-.Dd January 3, 2000
+.Dd June 30, 2007
 .Dt TVTOHZ 9
 .Os
 .Sh NAME
-.Nm tvtohz
+.Nm tvtohz_high ,
+.Nm tvtohz_low
 .Nd convert time interval to tick count
 .Sh SYNOPSIS
 .In sys/time.h
 .Ft int
-.Fn tvtohz "struct timeval *tv"
+.Fn tvtohz_high "struct timeval *tv"
+.Ft int
+.Fn tvtohz_low "struct timeval *tv"
 .Sh DESCRIPTION
 The
-.Fn tvtohz
-function accepts a single argument
+.Fn tvtohz_high
+and
+.Fn tvtohz_low
+functions accept a single argument
 .Fa tv
 which specifies the time interval over which to calculate the number
 of system ticks that would elapse.
 .Sh RETURN VALUES
-Returns the integral number of system ticks expected to elapse in the given
-interval, including the current tick.
+The
+.Fn tvtohz_high
+function returns the integral number of system ticks expected to elapse
+in the given interval.
+The return value is intended to be used in a clock interrupt timed operation
+and guaranteed to meet or exceed the requested time.
+The minimum return value is 1 tick and the function will average the
+calculation up.
+If any value greater than 0 microseconds is supplied, a value of at least 2
+will be returned to ensure that a near-term clock interrupt does not cause
+the timeout to occur (degenerately) early.
+.Pp
+The
+.Fn tvtohz_low
+function returns the uncompensated number of system ticks for the specified
+amount of time.
+A return value of 0 is possible if
+.Fa tv
+converts to less than 1 tick.
+.Pp
+If the reprensentation overflows, both functions return
+.Dv INT_MAX .
+.Sh FILES
+.Pa sys/kern/kern_clock.c
 .Sh SEE ALSO
 .Xr microtime 9 ,
 .Xr microuptime 9 ,
 .Xr timeout 9
 .Sh HISTORY
 The
-.Nm
+.Nm tvtohz
 function first appeared in
-.Fx 3.0
+.Fx 3.0 .
+It was split into
+.Nm
+and
+.Nm tvtohz_low
+by
+.An Matt Dillon
+in
+.Dx 1.0 .
 .Sh AUTHORS
-This manual page was written by
-.An Kelly Yancey Aq kbyanc@posi.net .
+.An -nosplit
+This manual page was originally written by
+.An Kelly Yancey Aq kbyanc@posi.net
+and later updated by
+.An Sascha Wildner .