# Fixes doc comment of Futex.wait · gitcafe/zig

[View on GitCafe](https://git.cafe/gitcafe/zig/commit/ef77cc0de1f4453d89d8841116eaa65a42a9c89f)

Repository: [gitcafe/zig](https://git.cafe/gitcafe/zig)

Visibility: public

Requested revision: ef77cc0de1f4453d89d8841116eaa65a42a9c89f

Requested commit: ef77cc0de1f4453d89d8841116eaa65a42a9c89f

Commit: ef77cc0de1f4453d89d8841116eaa65a42a9c89f

Tree: 02246336362aa127cf6c4ec806c6f38f0dc11fd4

Author: Lucas Santos

Committer: Andrew Kelley

## Message

```
Fixes doc comment of Futex.wait
On Windows, changing the value at the target address is not sufficient, there needs to be a wake call.
From [MSDN](https://learn.microsoft.com/en-us/windows/win32/api/synchapi/nf-synchapi-waitonaddress):
> If the value at Address differs from the value at CompareAddress, the function returns immediately. If the values are the same, the function does not return until another thread in the same process signals that the value at Address has changed by calling WakeByAddressSingle or WakeByAddressAll or the timeout elapses, whichever comes first.
We could note that this behavior is only observed on Windows. However, if we want the function to have consistent behavior across all platforms, we should require users to call wake. On platforms where changing the value is sufficient to wake the waiting thread, an unblocking of the thread without a matching wake would just be considered a spurious wake.

```

## Parents

- [9db3e23e8081e7598e35a2da53a2b29c064d8404](https://git.cafe/gitcafe/zig/commit/9db3e23e8081e7598e35a2da53a2b29c064d8404?format=markdown)

[Source at this commit](https://git.cafe/gitcafe/zig/tree/ef77cc0de1f4453d89d8841116eaa65a42a9c89f?format=markdown)