Author: mahadev Date: Fri Feb 19 02:33:37 2010 New Revision: 911676 URL: http://svn.apache.org/viewvc?rev=911676&view=rev Log: ZOOKEEPER-672. typo nits across documentation (Kay Kay via mahadev)
Modified: hadoop/zookeeper/trunk/CHANGES.txt hadoop/zookeeper/trunk/docs/javaExample.html hadoop/zookeeper/trunk/docs/javaExample.pdf hadoop/zookeeper/trunk/docs/recipes.html hadoop/zookeeper/trunk/docs/recipes.pdf hadoop/zookeeper/trunk/docs/zookeeperProgrammers.html hadoop/zookeeper/trunk/docs/zookeeperProgrammers.pdf hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/javaExample.xml hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/recipes.xml hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml Modified: hadoop/zookeeper/trunk/CHANGES.txt URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/CHANGES.txt?rev=911676&r1=911675&r2=911676&view=diff ============================================================================== --- hadoop/zookeeper/trunk/CHANGES.txt (original) +++ hadoop/zookeeper/trunk/CHANGES.txt Fri Feb 19 02:33:37 2010 @@ -221,6 +221,8 @@ ZOOKEEPER-673. Fix observer documentation regarding leader election (flavio via mahadev) + ZOOKEEPER-672. typo nits across documentation (Kay Kay via mahadev) + IMPROVEMENTS: ZOOKEEPER-473. cleanup junit tests to eliminate false positives due to "socket reuse" and failure to close client (phunt via mahadev) Modified: hadoop/zookeeper/trunk/docs/javaExample.html URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/javaExample.html?rev=911676&r1=911675&r2=911676&view=diff ============================================================================== --- hadoop/zookeeper/trunk/docs/javaExample.html (original) +++ hadoop/zookeeper/trunk/docs/javaExample.html Fri Feb 19 02:33:37 2010 @@ -332,7 +332,7 @@ } </pre> <p> - Recall that the Executor's job is to starts and stop the executable whose name you pass in on the command line. + Recall that the Executor's job is to start and stop the executable whose name you pass in on the command line. It does this in response to events fired by the ZooKeeper object. As you can see in the code above, the Executor passes a reference to itself as the Watcher argument in the ZooKeeper constructor. It also passes a reference to itself as DataMonitorListener argument to the DataMonitor constructor. Per the Executor's definition, it implements both these Modified: hadoop/zookeeper/trunk/docs/javaExample.pdf URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/javaExample.pdf?rev=911676&r1=911675&r2=911676&view=diff ============================================================================== Binary files - no diff available. Modified: hadoop/zookeeper/trunk/docs/recipes.html URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/recipes.html?rev=911676&r1=911675&r2=911676&view=diff ============================================================================== --- hadoop/zookeeper/trunk/docs/recipes.html (original) +++ hadoop/zookeeper/trunk/docs/recipes.html Fri Feb 19 02:33:37 2010 @@ -510,13 +510,13 @@ the create() call set to true. Because the <em>sequence</em> flag is set, the new pathnames will have the form _path-to-queue-node_/queue-X, where X is a monotonic increasing number. A - client that wants to be remove from the queue calls ZooKeeper's <strong>getChildren( )</strong> function, with + client that wants to be removed from the queue calls ZooKeeper's <strong>getChildren( )</strong> function, with <em>watch</em> set to true on the queue node, and begins processing nodes with the lowest number. The client does not need to issue another <strong>getChildren( )</strong> until it exhausts the list obtained from the first <strong>getChildren( )</strong> call. If there are are no children in the queue node, the - reader waits for a watch notification to check to queue again.</p> + reader waits for a watch notification to check the queue again.</p> <a name="N10138"></a><a name="sc_recipes_priorityQueues"></a> <h4>Priority Queues</h4> <p>To implement a priority queue, you need only make two simple @@ -524,7 +524,7 @@ recipe</a> . First, to add to a queue, the pathname ends with "queue-YY" where YY is the priority of the element with lower numbers representing higher priority (just like UNIX). Second, when removing - from the queue a client uses an up-to-date children list meaning that + from the queue, a client uses an up-to-date children list meaning that the client will invalidate previously obtained children lists if a watch notification triggers for the queue node.</p> <a name="N10147"></a><a name="sc_recipes_Locks"></a> Modified: hadoop/zookeeper/trunk/docs/recipes.pdf URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/recipes.pdf?rev=911676&r1=911675&r2=911676&view=diff ============================================================================== Binary files - no diff available. Modified: hadoop/zookeeper/trunk/docs/zookeeperProgrammers.html URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/zookeeperProgrammers.html?rev=911676&r1=911675&r2=911676&view=diff ============================================================================== --- hadoop/zookeeper/trunk/docs/zookeeperProgrammers.html (original) +++ hadoop/zookeeper/trunk/docs/zookeeperProgrammers.html Fri Feb 19 02:33:37 2010 @@ -510,8 +510,8 @@ <p>In distributed application engineering, the word <em>node</em> can refer to a generic host machine, a server, a member of an ensemble, a client process, etc. In the ZooKeeper - documentatin, <em>znodes</em> refer to the data nodes. - <em>Servers</em> to refer to machines that make up the + documentation, <em>znodes</em> refer to the data nodes. + <em>Servers</em> refer to machines that make up the ZooKeeper service; <em>quorum peers</em> refer to the servers that make up an ensemble; client refers to any host or process which uses a ZooKeeper service.</p> @@ -556,7 +556,7 @@ <a name="N100EF"></a><a name="Sequence+Nodes+--+Unique+Naming"></a> <h4>Sequence Nodes -- Unique Naming</h4> <p>When creating a znode you can also request that - ZooKeeper append a monotonicly increasing counter to the end + ZooKeeper append a monotonically increasing counter to the end of path. This counter is unique to the parent znode. The counter has a format of %010d -- that is 10 digits with 0 (zero) padding (the counter is formatted in this way to @@ -901,7 +901,7 @@ </p> -<p>One watch event will be sent to the client the data has changed. +<p>One watch event will be sent to the client when the data has changed. For example, if a client does a getData("/znode1", true) and later the data for /znode1 is changed or deleted, the client will get a watch event for /znode1. If /znode1 changes again, no watch event will be @@ -1606,7 +1606,7 @@ <dl> <dt> -<term>Simultaneously Conistent Cross-Client Views</term> +<term>Simultaneously Consistent Cross-Client Views</term> </dt> <dd> <p>ZooKeeper does not guarantee that at every instance in Modified: hadoop/zookeeper/trunk/docs/zookeeperProgrammers.pdf URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/zookeeperProgrammers.pdf?rev=911676&r1=911675&r2=911676&view=diff ============================================================================== Binary files - no diff available. Modified: hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/javaExample.xml URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/javaExample.xml?rev=911676&r1=911675&r2=911676&view=diff ============================================================================== --- hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/javaExample.xml (original) +++ hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/javaExample.xml Fri Feb 19 02:33:37 2010 @@ -125,7 +125,7 @@ <para> - Recall that the Executor's job is to starts and stop the executable whose name you pass in on the command line. + Recall that the Executor's job is to start and stop the executable whose name you pass in on the command line. It does this in response to events fired by the ZooKeeper object. As you can see in the code above, the Executor passes a reference to itself as the Watcher argument in the ZooKeeper constructor. It also passes a reference to itself as DataMonitorListener argument to the DataMonitor constructor. Per the Executor's definition, it implements both these Modified: hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/recipes.xml URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/recipes.xml?rev=911676&r1=911675&r2=911676&view=diff ============================================================================== --- hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/recipes.xml (original) +++ hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/recipes.xml Fri Feb 19 02:33:37 2010 @@ -258,14 +258,14 @@ the create() call set to true. Because the <emphasis>sequence</emphasis> flag is set, the new pathnames will have the form _path-to-queue-node_/queue-X, where X is a monotonic increasing number. A - client that wants to be remove from the queue calls ZooKeeper's <emphasis + client that wants to be removed from the queue calls ZooKeeper's <emphasis role="bold">getChildren( )</emphasis> function, with <emphasis>watch</emphasis> set to true on the queue node, and begins processing nodes with the lowest number. The client does not need to issue another <emphasis role="bold">getChildren( )</emphasis> until it exhausts the list obtained from the first <emphasis role="bold">getChildren( )</emphasis> call. If there are are no children in the queue node, the - reader waits for a watch notification to check to queue again.</para> + reader waits for a watch notification to check the queue again.</para> <section id="sc_recipes_priorityQueues"> <title>Priority Queues</title> @@ -275,7 +275,7 @@ recipe</ulink> . First, to add to a queue, the pathname ends with "queue-YY" where YY is the priority of the element with lower numbers representing higher priority (just like UNIX). Second, when removing - from the queue a client uses an up-to-date children list meaning that + from the queue, a client uses an up-to-date children list meaning that the client will invalidate previously obtained children lists if a watch notification triggers for the queue node.</para> </section> Modified: hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml?rev=911676&r1=911675&r2=911676&view=diff ============================================================================== --- hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml (original) +++ hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml Fri Feb 19 02:33:37 2010 @@ -175,8 +175,8 @@ <para>In distributed application engineering, the word <emphasis>node</emphasis> can refer to a generic host machine, a server, a member of an ensemble, a client process, etc. In the ZooKeeper - documentatin, <emphasis>znodes</emphasis> refer to the data nodes. - <emphasis>Servers</emphasis> to refer to machines that make up the + documentation, <emphasis>znodes</emphasis> refer to the data nodes. + <emphasis>Servers</emphasis> refer to machines that make up the ZooKeeper service; <emphasis>quorum peers</emphasis> refer to the servers that make up an ensemble; client refers to any host or process which uses a ZooKeeper service.</para> @@ -232,7 +232,7 @@ <title>Sequence Nodes -- Unique Naming</title> <para>When creating a znode you can also request that - ZooKeeper append a monotonicly increasing counter to the end + ZooKeeper append a monotonically increasing counter to the end of path. This counter is unique to the parent znode. The counter has a format of %010d -- that is 10 digits with 0 (zero) padding (the counter is formatted in this way to @@ -505,7 +505,7 @@ <listitem> <para><emphasis role="bold">One-time trigger</emphasis></para> - <para>One watch event will be sent to the client the data has changed. + <para>One watch event will be sent to the client when the data has changed. For example, if a client does a getData("/znode1", true) and later the data for /znode1 is changed or deleted, the client will get a watch event for /znode1. If /znode1 changes again, no watch event will be @@ -1103,7 +1103,7 @@ <variablelist> <varlistentry> - <term>Simultaneously Conistent Cross-Client Views</term> + <term>Simultaneously Consistent Cross-Client Views</term> <listitem> <para>ZooKeeper does not guarantee that at every instance in