From: Michael Paquier <michael@paquier.xyz>
Date: Sat, 9 Mar 2024 06:44:41 +0000 (+0900)
Subject: Document units of "timeout" in ConditionVariableTimedSleep()
X-Git-Tag: REL_17_BETA1~701
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=f160bf06f72ab242a8336eff108a1f4e69539b77;p=thirdparty%2Fpostgresql.git

Document units of "timeout" in ConditionVariableTimedSleep()

The timeout is passed down to WaitLatch() as milliseconds.

Author: Shveta Malik
Discussion: https://postgr.es/m/CAJpy0uC=xiBQD1WapgYYvOiytap6ULJaakLd867zZXqu9tYc8w@mail.gmail.com
---

diff --git a/src/backend/storage/lmgr/condition_variable.c b/src/backend/storage/lmgr/condition_variable.c
index 1e8559ed47b..112a518bae0 100644
--- a/src/backend/storage/lmgr/condition_variable.c
+++ b/src/backend/storage/lmgr/condition_variable.c
@@ -102,6 +102,8 @@ ConditionVariableSleep(ConditionVariable *cv, uint32 wait_event_info)
 /*
  * Wait for a condition variable to be signaled or a timeout to be reached.
  *
+ * The "timeout" is given in milliseconds.
+ *
  * Returns true when timeout expires, otherwise returns false.
  *
  * See ConditionVariableSleep() for general usage.