ZooKeeper
  1. ZooKeeper
  2. ZOOKEEPER-782

Incorrect C API documentation for Watches

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Trivial Trivial
    • Resolution: Fixed
    • Affects Version/s: 3.3.1
    • Fix Version/s: 3.4.0
    • Component/s: c client, documentation
    • Labels:
      None
    • Hadoop Flags:
      Reviewed
    • Release Note:
      Corrected documentation on watch behavior in C API

      Description

      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.

        Activity

        Hide
        Mahadev konar added a comment -

        Documentation change.

        Show
        Mahadev konar added a comment - Documentation change.
        Hide
        Hadoop QA added a comment -

        +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.

        Show
        Hadoop QA added a comment - +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.
        Hide
        Benjamin Reed added a comment -

        +1 i'll also fix the querity typo

        Show
        Benjamin Reed added a comment - +1 i'll also fix the querity typo
        Hide
        Benjamin Reed added a comment -

        Committed revision 1146820.

        Show
        Benjamin Reed added a comment - Committed revision 1146820.
        Hide
        Hudson added a comment -

        Integrated in ZooKeeper-trunk #1244 (See https://builds.apache.org/job/ZooKeeper-trunk/1244/)
        ZOOKEEPER-782. Incorrect C API documentation for Watches

        breed : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1146820
        Files :

        • /zookeeper/trunk/CHANGES.txt
        • /zookeeper/trunk/src/c/include/zookeeper.h
        Show
        Hudson added a comment - Integrated in ZooKeeper-trunk #1244 (See https://builds.apache.org/job/ZooKeeper-trunk/1244/ ) ZOOKEEPER-782 . Incorrect C API documentation for Watches breed : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1146820 Files : /zookeeper/trunk/CHANGES.txt /zookeeper/trunk/src/c/include/zookeeper.h

          People

          • Assignee:
            Mahadev konar
            Reporter:
            Dave Wright
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development