KhronosGroup / Vulkan-Docs

The Vulkan API Specification and related tools
Other
2.75k stars 462 forks source link

Ambiguous phrase: "the act of waiting" on a binary semaphore #2412

Open ixchow opened 4 weeks ago

ixchow commented 4 weeks ago

From Semaphore Waiting:

Unlike timeline semaphores, fences or events, the act of waiting for a binary semaphore also unsignals that semaphore.

This language is ambiguous as to when "the act of waiting" occurs. I believe the intent is that the semaphore is unsignaled after the wait completes; but "the act of waiting" can be read as happening when the wait begins.

I suggest:

Unlike timeline semaphores, fences or events, waiting for a binary semaphore also unsignals that semaphore when the wait completes.

Note that the phrases "when" and "after" are probably -- in the language of the spec -- ill-defined since (as far as I can tell) there isn't necessarily a globally-consistent timeline among all threads of execution implied. On the other hand these words are already used elsewhere in the section.

dgkoch commented 3 weeks ago

@ixchow that sounds reasonable - are you able to provide a pull request with the change?

ixchow commented 3 weeks ago

Pull request #2418 created.