diff options
author | Alejandro Colomar <alx@kernel.org> | 2024-03-07 03:21:28 +0100 |
---|---|---|
committer | Alejandro Colomar <alx@kernel.org> | 2024-03-12 18:23:31 +0100 |
commit | 14cad7b461b594e0439b8c02b5004e341c193c53 (patch) | |
tree | 0363cfc62208edd3dcafcf4503f0f5783aba8d5e | |
parent | 4d1b426e33f429cd6e692a91633f20af4b8b33c6 (diff) |
TIMESPEC_TO_TIMEVAL.3, TIMEVAL_TO_TIMESPEC.3: Document these macros
Reported-by: Guillem Jover <guillem@hadrons.org>
Reviewed-by: Oskari Pirhonen <xxc3ncoredxx@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
-rw-r--r-- | man3/TIMESPEC_TO_TIMEVAL.3 | 1 | ||||
-rw-r--r-- | man3/TIMEVAL_TO_TIMESPEC.3 | 32 |
2 files changed, 33 insertions, 0 deletions
diff --git a/man3/TIMESPEC_TO_TIMEVAL.3 b/man3/TIMESPEC_TO_TIMEVAL.3 new file mode 100644 index 000000000..30ab755d2 --- /dev/null +++ b/man3/TIMESPEC_TO_TIMEVAL.3 @@ -0,0 +1 @@ +.so man3/TIMEVAL_TO_TIMESPEC.3 diff --git a/man3/TIMEVAL_TO_TIMESPEC.3 b/man3/TIMEVAL_TO_TIMESPEC.3 new file mode 100644 index 000000000..6cdd72e3e --- /dev/null +++ b/man3/TIMEVAL_TO_TIMESPEC.3 @@ -0,0 +1,32 @@ +.\" Copyright (C) 2024 Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: Linux-man-pages-copyleft +.\" +.TH TIMEVAL_TO_TIMESPEC 3 (date) "Linux man-pages (unreleased)" +.SH NAME +TIMEVAL_TO_TIMESPEC, +TIMESPEC_TO_TIMEVAL +\- +convert between time structures +.SH SYNOPSIS +.nf +.B #define _GNU_SOURCE +.B #include <sys/time.h> +.P +.BI "void TIMEVAL_TO_TIMESPEC(const struct timeval *" tv ", struct timespec *" ts ); +.BI "void TIMESPEC_TO_TIMEVAL(struct timeval *" tv ", const struct timespec *" ts ); +.fi +.SH DESCRIPTION +These macros convert from a +.BR timeval (3type) +to a +.BR timespec (3type) +structure, +and vice versa, +respectively. +.P +This is especially useful for writing interfaces that receive a type, +but are implemented with calls to functions that receive the other one. +.SH STANDARDS +GNU, +BSD. |