From bed49f85a4b0b8fa52eb44f02775579af4e03c00 Mon Sep 17 00:00:00 2001
From: Jessica Hamilton <jessica.l.hamilton@gmail.com>
Date: Sat, 12 Mar 2022 09:23:10 +0000
Subject: [PATCH] OS.h: add a note about B_ABSOLUTE_REAL_TIME_TIMEOUT.

* B_ABSOLUTE_REAL_TIME_TIMEOUT is used for kernel timers, and
  must be used for absolute timeout values, rather than the
  B_ABSOLUTE_TIMEOUT flag. Discovered whilst implementing
  `pthread_timedjoin_np`.

Change-Id: I37ae057073ff5efeecc00406b132abf51bebbdc2
Reviewed-on: https://review.haiku-os.org/c/haiku/+/5100
Reviewed-by: Fredrik Holmqvist <fredrik.holmqvist@gmail.com>
Tested-by: Commit checker robot <no-reply+buildbot@haiku-os.org>
---
 headers/os/kernel/OS.h | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/headers/os/kernel/OS.h b/headers/os/kernel/OS.h
index e40449e377..741a9d318c 100644
--- a/headers/os/kernel/OS.h
+++ b/headers/os/kernel/OS.h
@@ -37,6 +37,9 @@ enum {
 	B_TIMEOUT_REAL_TIME_BASE		= 0x40,
 	B_ABSOLUTE_REAL_TIME_TIMEOUT	= B_ABSOLUTE_TIMEOUT
 										| B_TIMEOUT_REAL_TIME_BASE
+								/* fails after an absolute timeout
+												with B_TIMED_OUT based on the
+												real time clock */
 };