d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
4d2ff2330f
freebsd-nq/lib/libc/gen/timespec_get.3

87 lines
2.5 KiB
Groff
Raw Normal View History

Bring in timespce_get form NetBSD. Bring in the functionality for timespec_get from NetBSD. I've lightly edited the .c file to remove _DIAGASSERT because FreeBSD doesn't have that functionality and the typical #define'ing it to assert isn't right here. The man page is verbatim from NetBSD, but will be revised as part of a larger cleanup of the time man pages (they are inconsistent and vague in all the wrong places). Differential Review: https://reviews.freebsd.org/D16649
2018-08-10 15:16:30 +00:00
.\" $NetBSD: timespec_get.3,v 1.2 2016/10/04 10:46:40 wiz Exp $
.\"
.\" Copyright (c) 2016 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Kamil Rytarowski.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
Update man page to include FreeBSD-specific details. While this implements a standards-conforming C11 function, there's implementation details the programmer needs to know. Include those here. Make changes inspired by comments on the initial review as well, though mostly this involves stealing the epoch verbage from gettimeofday(2). Add myself to authors since I've now changed a substantial amount of this man page.
2018-08-10 15:16:41 +00:00
.Dd August 10, 2018
Bring in timespce_get form NetBSD. Bring in the functionality for timespec_get from NetBSD. I've lightly edited the .c file to remove _DIAGASSERT because FreeBSD doesn't have that functionality and the typical #define'ing it to assert isn't right here. The man page is verbatim from NetBSD, but will be revised as part of a larger cleanup of the time man pages (they are inconsistent and vague in all the wrong places). Differential Review: https://reviews.freebsd.org/D16649
2018-08-10 15:16:30 +00:00
.Dt TIMESPEC_GET 3
.Os
.Sh NAME
.Nm timespec_get
.Nd get current calendar time
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In time.h
.Ft int
.Fn timespec_get "struct timespec *ts" "int base"
.Sh DESCRIPTION
The
.Nm
function sets the interval pointed to by
.Fa ts
to hold the current calendar time based on the specified time base in
.Fa base .
.Pp
Update man page to include FreeBSD-specific details. While this implements a standards-conforming C11 function, there's implementation details the programmer needs to know. Include those here. Make changes inspired by comments on the initial review as well, though mostly this involves stealing the epoch verbage from gettimeofday(2). Add myself to authors since I've now changed a substantial amount of this man page.
2018-08-10 15:16:41 +00:00
The base
.Dv TIME_UTC
returns the time since the epoch.
This time is expressed in seconds and nanoseconds since midnight (0 hour), January 1, 1970.
In
.Fx ,
this corresponds to
.Dv CLOCK_REALTIME .
Bring in timespce_get form NetBSD. Bring in the functionality for timespec_get from NetBSD. I've lightly edited the .c file to remove _DIAGASSERT because FreeBSD doesn't have that functionality and the typical #define'ing it to assert isn't right here. The man page is verbatim from NetBSD, but will be revised as part of a larger cleanup of the time man pages (they are inconsistent and vague in all the wrong places). Differential Review: https://reviews.freebsd.org/D16649
2018-08-10 15:16:30 +00:00
.Sh RETURN VALUES
The
.Nm
function returns the passed value of
.Fa base
if successful, otherwise
.Dv 0
on failure.
.Sh SEE ALSO
Update man page to include FreeBSD-specific details. While this implements a standards-conforming C11 function, there's implementation details the programmer needs to know. Include those here. Make changes inspired by comments on the initial review as well, though mostly this involves stealing the epoch verbage from gettimeofday(2). Add myself to authors since I've now changed a substantial amount of this man page.
2018-08-10 15:16:41 +00:00
.Xr clock_gettime 2 ,
timespec_get(3): sort SEE ALSO correctly clock_gettime(2) should be mentioned before gettimeofday(2). Reported by: make manlint MFC after: 1 week Sponsored by: DellEMC Isilon
2020-12-11 02:22:42 +00:00
.Xr gettimeofday 2 ,
Update man page to include FreeBSD-specific details. While this implements a standards-conforming C11 function, there's implementation details the programmer needs to know. Include those here. Make changes inspired by comments on the initial review as well, though mostly this involves stealing the epoch verbage from gettimeofday(2). Add myself to authors since I've now changed a substantial amount of this man page.
2018-08-10 15:16:41 +00:00
.Xr time 3
Bring in timespce_get form NetBSD. Bring in the functionality for timespec_get from NetBSD. I've lightly edited the .c file to remove _DIAGASSERT because FreeBSD doesn't have that functionality and the typical #define'ing it to assert isn't right here. The man page is verbatim from NetBSD, but will be revised as part of a larger cleanup of the time man pages (they are inconsistent and vague in all the wrong places). Differential Review: https://reviews.freebsd.org/D16649
2018-08-10 15:16:30 +00:00
.Sh STANDARDS
The
.Nm
Update man page to include FreeBSD-specific details. While this implements a standards-conforming C11 function, there's implementation details the programmer needs to know. Include those here. Make changes inspired by comments on the initial review as well, though mostly this involves stealing the epoch verbage from gettimeofday(2). Add myself to authors since I've now changed a substantial amount of this man page.
2018-08-10 15:16:41 +00:00
function with a
.Fa base
of
.Dv TIME_UTC
conforms to
Bring in timespce_get form NetBSD. Bring in the functionality for timespec_get from NetBSD. I've lightly edited the .c file to remove _DIAGASSERT because FreeBSD doesn't have that functionality and the typical #define'ing it to assert isn't right here. The man page is verbatim from NetBSD, but will be revised as part of a larger cleanup of the time man pages (they are inconsistent and vague in all the wrong places). Differential Review: https://reviews.freebsd.org/D16649
2018-08-10 15:16:30 +00:00
.St -isoC-2011 .
.Sh HISTORY
This interface first appeared in
Update man page to include FreeBSD-specific details. While this implements a standards-conforming C11 function, there's implementation details the programmer needs to know. Include those here. Make changes inspired by comments on the initial review as well, though mostly this involves stealing the epoch verbage from gettimeofday(2). Add myself to authors since I've now changed a substantial amount of this man page.
2018-08-10 15:16:41 +00:00
.Fx 12 .
Bring in timespce_get form NetBSD. Bring in the functionality for timespec_get from NetBSD. I've lightly edited the .c file to remove _DIAGASSERT because FreeBSD doesn't have that functionality and the typical #define'ing it to assert isn't right here. The man page is verbatim from NetBSD, but will be revised as part of a larger cleanup of the time man pages (they are inconsistent and vague in all the wrong places). Differential Review: https://reviews.freebsd.org/D16649
2018-08-10 15:16:30 +00:00
.Sh AUTHORS
.An Kamil Rytarowski Aq Mt kamil@NetBSD.org
Update man page to include FreeBSD-specific details. While this implements a standards-conforming C11 function, there's implementation details the programmer needs to know. Include those here. Make changes inspired by comments on the initial review as well, though mostly this involves stealing the epoch verbage from gettimeofday(2). Add myself to authors since I've now changed a substantial amount of this man page.
2018-08-10 15:16:41 +00:00
.An Warner Losh Aq Mt imp@FreeBSD.org
Reference in New Issue Copy Permalink