Document units of "timeout" in ConditionVariableTimedSleep()

michaelpq · michaelpq · commit f160bf06f72a · 2024-03-09T15:44:41.000+09:00
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
@@ -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.

Original file line number	Diff line number	Diff line change
`@@ -102,6 +102,8 @@ ConditionVariableSleep(ConditionVariable *cv, uint32 wait_event_info)`
`102`	`102`	`/*`
`103`	`103`	`* Wait for a condition variable to be signaled or a timeout to be reached.`
`104`	`104`	`*`
	`105`	`+ * The "timeout" is given in milliseconds.`
	`106`	`+ *`
`105`	`107`	`* Returns true when timeout expires, otherwise returns false.`
`106`	`108`	`*`
`107`	`109`	`* See ConditionVariableSleep() for general usage.`