Expound further on the behaviour of Mutex#sleep #342
Conversation
|
@timabdulla Thank you for your contribution! The only spec on this I could find is here, which describes the mutex is relocked when woken up. If your statement is true, I'd like to see a spec or example of this so that I can better understand your meaning. And if that works, it might be worth adding the bit about relock to the documentation as well. |
|
sorry, the commit message wasn't worded in the most precise manner. I was having difficulty trying to concisely explain the omission that I saw in the documentation. the spec that you've linked to demonstrates exactly the behaviour I was meaning to explain in my documentation addition. when a thread calls Mutex#sleep, the thread is put to sleep and the mutex released; upon being woken up for any reason, the thread will attempt to reacquire the mutex. I found that this behaviour was not clearly explained in the existing docs. it's most easy to see the existence of this behaviour in the source[0], but I've also attached an example[1], though I think the rubyspec specs do a good job of illuming this behaviour. [0] https://github.com/ruby/ruby/blob/trunk/thread.c#L4547-L4552 |
|
@timabdulla I think the confusion is the phrase "reacquire the mutex", but you should say "reacquire the lock". I think it is easier to understand. |
The documentation for Mutex#sleep did not previously note that after the thread is woken up, it will attempt to reacquire the lock. This note has now been added.
|
@zzak cool, I agree. I modified the wording and updated the commit |
|
No objection. |
By Tim Abdulla [Fixes rubyGH-342] ruby#342 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@41977 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
The documentation for Mutex#sleep did not previously note that
after the thread that is put to sleep by the call to wait is woken
up, it will attempt to reacquire the mutex. This note has now been
added.