DragonFly BSD
DragonFly submit List (threaded) for 2010-03
[Date Prev][Date Next]  [Thread Prev][Thread Next]  [Date Index][Thread Index]

[PATCH 2/2] callout.9: document callout_reset_{,m}s


From: Constantine A. Murenin <cnst+dfly@xxxxxxxxxxxxxxx>
Date: Wed, 24 Feb 2010 22:03:51 -0500

---
 share/man/man9/Makefile  |    2 ++
 share/man/man9/callout.9 |   15 +++++++++++++++
 2 files changed, 17 insertions(+), 0 deletions(-)

diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index 3e52f7b..d00f220 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -332,6 +332,8 @@ MLINKS+=callout.9 callout_active.9 \
 	callout.9 callout_init_mp.9 \
 	callout.9 callout_pending.9 \
 	callout.9 callout_reset.9 \
+	callout.9 callout_reset_ms.9 \
+	callout.9 callout_reset_s.9 \
 	callout.9 callout_stop.9 \
 	callout.9 timeout.9 \
 	callout.9 untimeout.9
diff --git a/share/man/man9/callout.9 b/share/man/man9/callout.9
index 88191d1..f9c0e67 100644
--- a/share/man/man9/callout.9
+++ b/share/man/man9/callout.9
@@ -44,6 +44,8 @@
 .Nm callout_init ,
 .Nm callout_init_mp ,
 .Nm callout_reset ,
+.Nm callout_reset_s ,
+.Nm callout_reset_ms ,
 .Nm callout_stop ,
 .Nm callout_active ,
 .Nm callout_pending ,
@@ -61,6 +63,10 @@ typedef void timeout_t (void *);
 .Fn callout_init_mp "struct callout *c"
 .Ft void
 .Fn callout_reset "struct callout *c" "int ticks" "timeout_t *func" "void *arg"
+.Ft void
+.Fn callout_reset_s "struct callout *c" "int s" "timeout_t *func" "void *arg"
+.Ft void
+.Fn callout_reset_ms "struct callout *c" "int ms" "timeout_t *func" "void *arg"
 .Ft int
 .Fn callout_stop "struct callout *c"
 .Ft int
@@ -115,6 +121,15 @@ seconds, the function specified by
 will be called with the argument
 .Fa arg .
 .Pp
+The
+.Fn callout_reset_s
+and
+.Fn callout_reset_ms
+functions can be used in place of the
+.Fn callout_reset
+function with the timeout value expressed
+in seconds and milliseconds, respectively.
+.Pp
 The function
 .Fn callout_stop
 cancels the callout associated with the callout handle
-- 
1.6.6


--M9NhX3UHpAaciwkO--



[Date Prev][Date Next]  [Thread Prev][Thread Next]  [Date Index][Thread Index]