Skip to contentSkip to conversation

TIMESPEC_TO_TIMEVAL.3, TIMEVAL_TO_TIMESPEC.3: Document these macros

PATCH In review Alejandro Colomar 2 participants 3 messages Mar 7, 2024 – Mar 8, 2024 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore

Alejandro Colomar

author maintainer
#0 lore raw

PATCH 1/1 TIMESPEC_TO_TIMEVAL.3, TIMEVAL_TO_TIMESPEC.3: Document these macros

Reported-by Guillem Jover <[email protected]>
Cc Oskari Pirhonen <[email protected]>
Signed-off-by Alejandro Colomar <[email protected]>
---
 man3/TIMESPEC_TO_TIMEVAL.3 |  1 +
 man3/TIMEVAL_TO_TIMESPEC.3 | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+)
 create mode 100644 man3/TIMESPEC_TO_TIMEVAL.3
 create mode 100644 man3/TIMEVAL_TO_TIMESPEC.3
man3/TIMESPEC_TO_TIMEVAL.3 new file +1 -0
new file mode 100644
index 000000000..30ab755d2
@@ -0,0 +1 @@
+.so man3/TIMEVAL_TO_TIMESPEC.3
man3/TIMEVAL_TO_TIMESPEC.3 new file +32 -0
new file mode 100644
index 000000000..6cdd72e3e
@@ -0,0 +1,32 @@
+.\" Copyright (C) 2024 Alejandro Colomar <[email protected]>
+.\"
+.\" 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.
Signature · 1 line
2.43.0