[PATCH] TIMESPEC_TO_TIMEVAL.3, TIMEVAL_TO_TIMESPEC.3: Document these macros

[PATCH] TIMESPEC_TO_TIMEVAL.3, TIMEVAL_TO_TIMESPEC.3: Document these macros

[Alejandro Colomar]

[-- Attachment #1: Type: text/plain, Size: 1683 bytes --]

Reported-by: Guillem Jover <guillem@hadrons.org>
Cc: Oskari Pirhonen <xxc3ncoredxx@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
---
 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

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.
-- 
2.43.0


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH] TIMESPEC_TO_TIMEVAL.3, TIMEVAL_TO_TIMESPEC.3: Document these macros

[Oskari Pirhonen]

[-- Attachment #1: Type: text/plain, Size: 297 bytes --]

On Thu, Mar 07, 2024 at 03:25:01 +0100, Alejandro Colomar wrote:
> Reported-by: Guillem Jover <guillem@hadrons.org>
> Cc: Oskari Pirhonen <xxc3ncoredxx@gmail.com>
> Signed-off-by: Alejandro Colomar <alx@kernel.org>

Looks OK to me.

Reviewed-by: Oskari Pirhonen <xxc3ncoredxx@gmail.com>

- Oskari

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH] TIMESPEC_TO_TIMEVAL.3, TIMEVAL_TO_TIMESPEC.3: Document these macros

[Alejandro Colomar]

[-- Attachment #1: Type: text/plain, Size: 460 bytes --]

On Thu, Mar 07, 2024 at 11:23:18PM -0600, Oskari Pirhonen wrote:
> On Thu, Mar 07, 2024 at 03:25:01 +0100, Alejandro Colomar wrote:
> > Reported-by: Guillem Jover <guillem@hadrons.org>
> > Cc: Oskari Pirhonen <xxc3ncoredxx@gmail.com>
> > Signed-off-by: Alejandro Colomar <alx@kernel.org>
> 
> Looks OK to me.
> 
> Reviewed-by: Oskari Pirhonen <xxc3ncoredxx@gmail.com>

Thanks!

Have a lovely day!
Alex

-- 
<https://www.alejandro-colomar.es/>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]