Module Name: src
Committed By: wiz
Date: Wed Feb 3 08:47:40 UTC 2010
Modified Files:
src/lib/libc/time: ctime.3
Log Message:
Remove trailing whitespace. Use Fn when referencing functions. Sort sections.
New sentence, new line.
To generate a diff of this commit:
cvs rdiff -u -r1.30 -r1.31 src/lib/libc/time/ctime.3
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/lib/libc/time/ctime.3
diff -u src/lib/libc/time/ctime.3:1.30 src/lib/libc/time/ctime.3:1.31
--- src/lib/libc/time/ctime.3:1.30 Tue Feb 2 19:04:37 2010
+++ src/lib/libc/time/ctime.3 Wed Feb 3 08:47:40 2010
@@ -1,4 +1,4 @@
-.\" $NetBSD: ctime.3,v 1.30 2010/02/02 19:04:37 christos Exp $
+.\" $NetBSD: ctime.3,v 1.31 2010/02/03 08:47:40 wiz Exp $
.Dd February 2, 2010
.Dt CTIME 3
.Os
@@ -70,7 +70,7 @@
structure,
.Fn localtime
(such as Daylight Saving Time in the United States).
-After filling in the
+After filling in the
.Va tm
structure,
.Fn localtime
@@ -154,7 +154,7 @@
are determined.
.Fn mktime
returns the specified calendar time; if the calendar time cannot be
-represented, it returns
+represented, it returns
.Va "(time_t)-1" .
.Pp
.Fn difftime
@@ -198,27 +198,27 @@
of the Prime Meridian.
.Sh RETURN VALUES
On success the
-.Nm asctime
+.Fn asctime
and
-.Nm ctime
+.Fn ctime
functions return a pointer to a static character buffer, and the
-.Nm asctime_r
+.Fn asctime_r
and
-.Nm ctime_r
+.Fn ctime_r
function return a pointer to the user-supplied buffer.
On failure they all return
.Dv NULL
and no errors are defined for them.
On success the
-.Nm gmtime ,
+.Fn gmtime ,
and
-.Nm localtime
+.Fn localtime
functions return a pointer to a statically allocated
.Va "struct tm"
whereas the
-.Nm gmtime_r
+.Fn gmtime_r
and
-.Nm localtime_r
+.Fn localtime_r
functions return a pointer to the user-supplied
.Va "struct tm" .
On failure they all return
@@ -227,29 +227,17 @@
.Va errno
is set to indicate the error.
The
-.Nm mktime
+.Fn mktime
function returns the specified time since the Epoch as a
.Va time_t
-type value. If the time cannot be represented, then
-.Nm mktime
+type value.
+If the time cannot be represented, then
+.Fn mktime
returns
.Va "(time_t)-1"
setting the global variable
.Va errno
to indicate the error.
-.Sh ERRORS
-The
-.Nm gmtime_r ,
-.Nm localtime_r ,
-.Nm gmtime ,
-.Nm localtime ,
-and
-.Nm mktime
-will fail when:
-.Bl -tag -width Er
-.It Bq Er EOVERFLOW
-The result cannot be represented.
-.El
.Sh FILES
.Bl -tag -width /usr/share/zoneinfo/posixrules -compact
.It Pa /etc/localtime
@@ -266,6 +254,19 @@
.Pa /usr/share/zoneinfo/GMT
is absent, UTC leap seconds are loaded from
.Pa /usr/share/zoneinfo/posixrules .
+.Sh ERRORS
+The
+.Fn gmtime_r ,
+.Fn localtime_r ,
+.Fn gmtime ,
+.Fn localtime ,
+and
+.Fn mktime
+will fail when:
+.Bl -tag -width Er
+.It Bq Er EOVERFLOW
+The result cannot be represented.
+.El
.Sh SEE ALSO
.Xr getenv 3 ,
.Xr strftime 3 ,
