[
https://issues.apache.org/jira/browse/CURATOR-530?focusedWorklogId=274943&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-274943
]
ASF GitHub Bot logged work on CURATOR-530:
------------------------------------------
Author: ASF GitHub Bot
Created on: 10/Jul/19 16:38
Start Date: 10/Jul/19 16:38
Worklog Time Spent: 10m
Work Description: shayshim commented on pull request #315: [CURATOR-530]
Documentation on InterProcessSemaphoreMutex is misleading
URL: https://github.com/apache/curator/pull/315#discussion_r302164352
##########
File path:
curator-recipes/src/main/java/org/apache/curator/framework/recipes/locks/InterProcessMultiLock.java
##########
@@ -145,6 +145,9 @@ public boolean acquire(long time, TimeUnit unit) throws
Exception
* {@inheritDoc}
*
* <p>NOTE: locks are released in the reverse order that they were
acquired.</p>
+ *
+ * @throws Exception ZK errors, interruptions, current thread does not own
the lock
Review comment:
Seems right, but don't you need to add now same "@throws" text also for
InterProcessMutex.release()? (This is also the actual code that throws
IllegalMonitorStateException in case of different thread, and used internally
here)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 274943)
Time Spent: 20m (was: 10m)
> Documentation on InterProcessSemaphoreMutex is misleading
> ---------------------------------------------------------
>
> Key: CURATOR-530
> URL: https://issues.apache.org/jira/browse/CURATOR-530
> Project: Apache Curator
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 4.0.1
> Reporter: Emre Tetik
> Priority: Major
> Labels: documentation, easyfix, pull-request-available
> Time Spent: 20m
> Remaining Estimate: 0h
>
> The documentation for the release() method in InterProcessSemaphoreMutex says
> that it will throw an exception if the method is called on a thread other
> than the one which acquired the lock:
> [https://curator.apache.org/apidocs/org/apache/curator/framework/recipes/locks/InterProcessSemaphoreMutex.html#release--]
> This is not correct, and should be changed.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
