[jira] [Commented] (ZOOKEEPER-782) Incorrect C API documentation for Watches

["Hadoop QA (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/ZOOKEEPER-782?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13064909#comment-13064909 ] 

Hadoop QA commented on ZOOKEEPER-782:
-------------------------------------

+1 overall.  Here are the results of testing the latest attachment 
  http://issues.apache.org/jira/secure/attachment/12486375/ZOOKEEPER-782.patch
  against trunk revision 1146025.

    +1 @author.  The patch does not contain any @author tags.

    +0 tests included.  The patch appears to be a documentation patch that doesn't require tests.

    +1 javadoc.  The javadoc tool did not generate any warning messages.

    +1 javac.  The applied patch does not increase the total number of javac compiler warnings.

    +1 findbugs.  The patch does not introduce any new Findbugs (version 1.3.9) warnings.

    +1 release audit.  The applied patch does not increase the total number of release audit warnings.

    +1 core tests.  The patch passed core unit tests.

    +1 contrib tests.  The patch passed contrib unit tests.

Test results: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/391//testReport/
Findbugs warnings: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/391//artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
Console output: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/391//console

This message is automatically generated.

> Incorrect C API documentation for Watches
> -----------------------------------------
>
>                 Key: ZOOKEEPER-782
>                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-782
>             Project: ZooKeeper
>          Issue Type: Bug
>          Components: c client, documentation
>    Affects Versions: 3.3.1
>            Reporter: Dave Wright
>            Priority: Trivial
>             Fix For: 3.4.0
>
>         Attachments: ZOOKEEPER-782.patch
>
>
>  The C API Doxygen documentation states:
> " .... If the client is ever disconnected from the service, even if the
>   disconnection is temporary, the watches of the client will be removed from
>   the service, so a client must treat a disconnect notification as an implicit
>   trigger of all outstanding watches."
> This is incorrect as of v.3. Watches are only lost and need to be re-registered when a session times out. When a normal disconnection occurs watches are reset automatically on reconnection.
> The documentation in zookeeper.h needs to be updated to correct this explanation.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira