You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@curator.apache.org by ra...@apache.org on 2014/06/07 20:19:39 UTC
[41/50] [abbrv] git commit: doc wip
doc wip
Project: http://git-wip-us.apache.org/repos/asf/curator/repo
Commit: http://git-wip-us.apache.org/repos/asf/curator/commit/9077ad00
Tree: http://git-wip-us.apache.org/repos/asf/curator/tree/9077ad00
Diff: http://git-wip-us.apache.org/repos/asf/curator/diff/9077ad00
Branch: refs/heads/master
Commit: 9077ad001b32868ac9abcf172438dff9ff82e52f
Parents: 30019cd
Author: randgalt <ra...@apache.org>
Authored: Mon Jun 2 11:20:34 2014 -0500
Committer: randgalt <ra...@apache.org>
Committed: Mon Jun 2 11:20:34 2014 -0500
----------------------------------------------------------------------
.../src/site/confluence/configuration.confluence | 15 +++++----------
.../src/site/confluence/reference.confluence | 16 +++++++---------
curator-x-rpc/src/site/confluence/usage.confluence | 2 +-
3 files changed, 13 insertions(+), 20 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/curator/blob/9077ad00/curator-x-rpc/src/site/confluence/configuration.confluence
----------------------------------------------------------------------
diff --git a/curator-x-rpc/src/site/confluence/configuration.confluence b/curator-x-rpc/src/site/confluence/configuration.confluence
index d2ae8c8..21912ae 100644
--- a/curator-x-rpc/src/site/confluence/configuration.confluence
+++ b/curator-x-rpc/src/site/confluence/configuration.confluence
@@ -124,22 +124,17 @@ h3. Retry
The retry policy configuration depends on what type is used. There 3 types supported:
-_exponential\-backoff_
||Name||Type||Default Value||Description||
-|type|string|n/a|"exponential\-backoff"|
+|type|string|n/a|*exponential\-backoff*|
|baseSleepTime|Duration|100 milliseconds|The base sleep time|
|maxRetries|int|3|The max retries|
-
-_bounded\-exponential\-backoff_
-||Name||Type||Default Value||Description||
-|type|string|n/a|"bounded\-exponential\-backoff"|
+|\_|\_|\_|\_|
+|type|string|n/a|*bounded\-exponential\-backoff*|
|baseSleepTime|Duration|100 milliseconds|The base sleep time|
|maxSleepTime|Duration|30 seconds|The max sleep time|
|maxRetries|int|3|The max retries|
-
-_ntimes_
-||Name||Type||Default Value||Description||
-|type|string|n/a|"ntimes"|
+|\_|\_|\_|\_|
+|type|string|n/a|*ntimes*|
|sleepBetweenRetries|int|100 milliseconds|sleep time between retries|
|n|int|3|the number of retries|
http://git-wip-us.apache.org/repos/asf/curator/blob/9077ad00/curator-x-rpc/src/site/confluence/reference.confluence
----------------------------------------------------------------------
diff --git a/curator-x-rpc/src/site/confluence/reference.confluence b/curator-x-rpc/src/site/confluence/reference.confluence
index 0ecb26b..dde323f 100644
--- a/curator-x-rpc/src/site/confluence/reference.confluence
+++ b/curator-x-rpc/src/site/confluence/reference.confluence
@@ -47,12 +47,10 @@ h2. DiscoveryService
h1. Struct Reference
-_Required fields have (r) in the description_
-
h2. CreateSpec
||Field||Type||Description||
-|path|string|(r) the ZNode path|
+|path|string|the ZNode path \- *required*|
|data|bytes|data for the node|
|mode|CreateMode|PERSISTENT, PERSISTENT\_SEQUENTIAL, EPHEMERAL, or EPHEMERAL\_SEQUENTIAL|
|asyncContext|string|if not null, createNode() is performed asynchronously and this is the context used in the async message|
@@ -63,7 +61,7 @@ h2. CreateSpec
h2. DeleteSpec
||Field||Type||Description||
-|path|string|(r) the ZNode path|
+|path|string|the ZNode path \- *required*|
|guaranteed|bool|if true, use guaranteed deletion|
|asyncContext|string|if not null, createNode() is performed asynchronously and this is the context used in the async message|
|compressed|bool|if true, compress the data|
@@ -72,7 +70,7 @@ h2. DeleteSpec
h2. GetDataSpec
||Field||Type||Description||
-|path|string|(r) the ZNode path|
+|path|string|the ZNode path \- *required*|
|watched|bool|if true, trigger watch events for this node|
|asyncContext|string|if not null, createNode() is performed asynchronously and this is the context used in the async message|
|decompressed|bool|if true, decompress the data|
@@ -80,8 +78,8 @@ h2. GetDataSpec
h2. SetDataSpec
||Field||Type||Description||
-|path|string|(r) the ZNode path|
-|data|bytes|(r) data for the node|
+|path|string|the ZNode path \- *required*|
+|data|bytes|data for the node \- *required*|
|watched|bool|if true, trigger watch events for this node|
|asyncContext|string|if not null, createNode() is performed asynchronously and this is the context used in the async message|
|compressed|bool|if true, compress the data|
@@ -90,14 +88,14 @@ h2. SetDataSpec
h2. ExistsSpec
||Field||Type||Description||
-|path|string|(r) the ZNode path|
+|path|string|the ZNode path \- *required*|
|watched|bool|if true, trigger watch events for this node|
|asyncContext|string|if not null, createNode() is performed asynchronously and this is the context used in the async message|
h2. GetChildrenSpec
||Field||Type||Description||
-|path|string|(r) the ZNode path|
+|path|string|the ZNode path \- *required*|
|watched|bool|if true, trigger watch events for this node|
|asyncContext|string|if not null, createNode() is performed asynchronously and this is the context used in the async message|
http://git-wip-us.apache.org/repos/asf/curator/blob/9077ad00/curator-x-rpc/src/site/confluence/usage.confluence
----------------------------------------------------------------------
diff --git a/curator-x-rpc/src/site/confluence/usage.confluence b/curator-x-rpc/src/site/confluence/usage.confluence
index 86befd1..e9da75f 100644
--- a/curator-x-rpc/src/site/confluence/usage.confluence
+++ b/curator-x-rpc/src/site/confluence/usage.confluence
@@ -10,7 +10,7 @@ Details on using Apache Thrift can be found here: [[http://thrift.apache.org]].
h2. Prerequisites
-It's assumed you already familiar with ZooKeeper and Curator. Also, familiarity with writing Thrift applications is helpful.
+It's assumed you are already familiar with ZooKeeper and Curator. Also, familiarity with writing Thrift applications is helpful.
h2. Services