[src/trunk]: src/share/man/man9 Document clock_ymdhms_to_secs()' returning -1...

[bjh21 <bjh21%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/5dd9ae14b9cc
branches:  trunk
changeset: 572321:5dd9ae14b9cc
user:      bjh21 <bjh21%NetBSD.org@localhost>
date:      Wed Dec 29 20:56:43 2004 +0000

description:
Document clock_ymdhms_to_secs()' returning -1 for unrepresentable input.

diffstat:

 share/man/man9/todr.9 |  14 +++++++++-----
 1 files changed, 9 insertions(+), 5 deletions(-)

diffs (37 lines):

diff -r 0dfa457903c3 -r 5dd9ae14b9cc share/man/man9/todr.9
--- a/share/man/man9/todr.9     Wed Dec 29 20:55:57 2004 +0000
+++ b/share/man/man9/todr.9     Wed Dec 29 20:56:43 2004 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: todr.9,v 1.8 2003/08/07 09:41:14 wiz Exp $
+.\" $NetBSD: todr.9,v 1.9 2004/12/29 20:56:43 bjh21 Exp $
 .\"
 .\" Copyright (c) 2000, 2003 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -34,7 +34,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd July 18, 2003
+.Dd December 29, 2004
 .Dt TODR 9
 .Os
 .Sh NAME
@@ -139,11 +139,15 @@
 However, behaviour is undefined if an invalid
 .Fa todr_chip_handle_t
 is passed to any of these functions.
+.Pp
+The
+.Fn clock_ymdhms_to_secs
+function returns -1 if the time in seconds would be less that zero or too
+large to fit in a
+.Fa time_t .
 The
 .Fn clock_secs_to_ymdhms
-and
-.Fn clock_ymdhms_to_secs
-functions never fail.
+function never fails.
 .Sh SEE ALSO
 .Xr intersil7170 4 ,
 .Xr mk48txx 4 ,