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 2017/07/23 02:40:26 UTC
[1/2] curator git commit: some doc changes: :
Repository: curator
Updated Branches:
refs/heads/CURATOR-426 e819268dc -> b26410d53
some doc changes:
:
Project: http://git-wip-us.apache.org/repos/asf/curator/repo
Commit: http://git-wip-us.apache.org/repos/asf/curator/commit/7d7cb9d6
Tree: http://git-wip-us.apache.org/repos/asf/curator/tree/7d7cb9d6
Diff: http://git-wip-us.apache.org/repos/asf/curator/diff/7d7cb9d6
Branch: refs/heads/CURATOR-426
Commit: 7d7cb9d6ab1084c053839416d71607479bd356de
Parents: e819268
Author: randgalt <ra...@apache.org>
Authored: Sat Jul 22 13:26:41 2017 -0500
Committer: randgalt <ra...@apache.org>
Committed: Sat Jul 22 13:26:41 2017 -0500
----------------------------------------------------------------------
src/site/confluence/compatibility.confluence | 54 +++-----------------
src/site/confluence/zk-compatibility.confluence | 48 +++++++++++++++++
src/site/site.xml | 5 +-
3 files changed, 59 insertions(+), 48 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/curator/blob/7d7cb9d6/src/site/confluence/compatibility.confluence
----------------------------------------------------------------------
diff --git a/src/site/confluence/compatibility.confluence b/src/site/confluence/compatibility.confluence
index 4103bf2..467f1fc 100644
--- a/src/site/confluence/compatibility.confluence
+++ b/src/site/confluence/compatibility.confluence
@@ -1,48 +1,10 @@
-h1. ZooKeeper Version Compatibility
+h1. API Compatibility
-While ZooKeeper 3.5.x is still considered "beta" by the ZooKeeper development team, the reality is that it is
-used in production by many users. However, ZooKeeper 3.4.x is also used in production. Prior to Apache Curator
-4.0, both versions of ZooKeeper were supported via two versions of Apache Curator. Starting with Curator 4.0
-both versions of ZooKeeper are supported via the same Curator libraries.
-
-h2. ZooKeeper 3.5.x
-
-* Curator 4.0 has a hard dependency on ZooKeeper 3.5.x
-* If you are using ZooKeeper 3.5.x there's nothing additional to do \- just use Curator 4.0
-
-h2. ZooKeeper 3.4.x
-
-Curator 4.0 supports ZooKeeper 3.4.x ensembles in a soft\-compatibility mode. To use this mode
-you must exclude ZooKeeper when adding Curator to your dependency management tool.
-
-_Maven_
-
-{code}
-<dependency>
- <groupId>org.apache.curator</groupId>
- <artifactId>curator-recipes</artifactId>
- <version>${curator-version}</version>
- <exclusions>
- <exclusion>
- <groupId>org.apache.zookeeper</groupId>
- <artifactId>zookeeper</artifactId>
- </exclusion>
- </exclusions>
-</dependency>
-{code}
-
-_Gradle_
-
-{code}
-compile('org.apache.curator:curator-recipes:$curatorVersion') {
- exclude('org.apache.zookeeper:zookeeper')
-}
-{code}
-
-You must add a dependency on ZooKeeper 3.4.x also.
-
-Curator will detect which ZooKeeper library is in use and automatically set ZooKeeper 3.4 compatibility
-mode as needed. In this mode, all features not supported by 3.4 are disabled. It is up to your
-application code to "do the right thing" and not use these features. Use the {{isZk34CompatibilityMode()}}
-method to determine which mode Curator is using at runtime.
+A [[Clirr|http://clirr.sourceforge.net/]] report is generated for each Curator module:
+* [[Curator Client Report|curator-client/clirr-report.html]]
+* [[Curator Framework Report|curator-framework/clirr-report.html]]
+* [[Curator Recipes Report|curator-recipes/clirr-report.html]]
+* [[Curator Async Report|curator-x-async/clirr-report.html]]
+* [[Curator Discovery Report|curator-x-discovery/clirr-report.html]]
+* [[Curator Discovery Server Report|curator-x-discovery-server/clirr-report.html]]
http://git-wip-us.apache.org/repos/asf/curator/blob/7d7cb9d6/src/site/confluence/zk-compatibility.confluence
----------------------------------------------------------------------
diff --git a/src/site/confluence/zk-compatibility.confluence b/src/site/confluence/zk-compatibility.confluence
new file mode 100644
index 0000000..4103bf2
--- /dev/null
+++ b/src/site/confluence/zk-compatibility.confluence
@@ -0,0 +1,48 @@
+h1. ZooKeeper Version Compatibility
+
+While ZooKeeper 3.5.x is still considered "beta" by the ZooKeeper development team, the reality is that it is
+used in production by many users. However, ZooKeeper 3.4.x is also used in production. Prior to Apache Curator
+4.0, both versions of ZooKeeper were supported via two versions of Apache Curator. Starting with Curator 4.0
+both versions of ZooKeeper are supported via the same Curator libraries.
+
+h2. ZooKeeper 3.5.x
+
+* Curator 4.0 has a hard dependency on ZooKeeper 3.5.x
+* If you are using ZooKeeper 3.5.x there's nothing additional to do \- just use Curator 4.0
+
+h2. ZooKeeper 3.4.x
+
+Curator 4.0 supports ZooKeeper 3.4.x ensembles in a soft\-compatibility mode. To use this mode
+you must exclude ZooKeeper when adding Curator to your dependency management tool.
+
+_Maven_
+
+{code}
+<dependency>
+ <groupId>org.apache.curator</groupId>
+ <artifactId>curator-recipes</artifactId>
+ <version>${curator-version}</version>
+ <exclusions>
+ <exclusion>
+ <groupId>org.apache.zookeeper</groupId>
+ <artifactId>zookeeper</artifactId>
+ </exclusion>
+ </exclusions>
+</dependency>
+{code}
+
+_Gradle_
+
+{code}
+compile('org.apache.curator:curator-recipes:$curatorVersion') {
+ exclude('org.apache.zookeeper:zookeeper')
+}
+{code}
+
+You must add a dependency on ZooKeeper 3.4.x also.
+
+Curator will detect which ZooKeeper library is in use and automatically set ZooKeeper 3.4 compatibility
+mode as needed. In this mode, all features not supported by 3.4 are disabled. It is up to your
+application code to "do the right thing" and not use these features. Use the {{isZk34CompatibilityMode()}}
+method to determine which mode Curator is using at runtime.
+
http://git-wip-us.apache.org/repos/asf/curator/blob/7d7cb9d6/src/site/site.xml
----------------------------------------------------------------------
diff --git a/src/site/site.xml b/src/site/site.xml
index 97fb05c..85c4f36 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -85,7 +85,7 @@
</menu>
<menu name="Compatibility" inherit="top">
- <item name="ZooKeeper Versions" href="compatibility.html"/>
+ <item name="ZooKeeper Versions" href="zk-compatibility.html"/>
</menu>
<menu name="Low Level" inherit="top">
@@ -102,6 +102,7 @@
<item name="Source Code" href="source-repository.html"/>
<item name="Project Team" href="team-list.html"/>
<item name="Project Information" href="project-info.html"/>
+ <item name="API Compatibility" href="compatibility.html"/>
<item name="Javadoc" href="apidocs/index.html"/>
<item name="Wiki" href="https://cwiki.apache.org/confluence/display/CURATOR"/>
<item name="Releases" href="https://cwiki.apache.org/confluence/display/CURATOR/Releases"/>
@@ -110,7 +111,7 @@
<menu name="Extensions" inherit="top">
<item name="Service Discovery" href="curator-x-discovery/index.html"/>
<item name="Service Discovery Server" href="curator-x-discovery-server/index.html"/>
-\ </menu>
+ </menu>
<menu name="Community" inherit="top">
<item name="Submitting Pull Requests" href="https://cwiki.apache.org/confluence/display/CURATOR/Submitting+Pull+Requests"/>
[2/2] curator git commit: some doc changes
Posted by ra...@apache.org.
some doc changes
Project: http://git-wip-us.apache.org/repos/asf/curator/repo
Commit: http://git-wip-us.apache.org/repos/asf/curator/commit/b26410d5
Tree: http://git-wip-us.apache.org/repos/asf/curator/tree/b26410d5
Diff: http://git-wip-us.apache.org/repos/asf/curator/diff/b26410d5
Branch: refs/heads/CURATOR-426
Commit: b26410d53aefa7cc46e0a6edd4e03f35298077ee
Parents: 7d7cb9d
Author: randgalt <ra...@apache.org>
Authored: Sat Jul 22 14:12:51 2017 -0500
Committer: randgalt <ra...@apache.org>
Committed: Sat Jul 22 14:12:51 2017 -0500
----------------------------------------------------------------------
src/site/confluence/index.confluence | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/curator/blob/b26410d5/src/site/confluence/index.confluence
----------------------------------------------------------------------
diff --git a/src/site/confluence/index.confluence b/src/site/confluence/index.confluence
index e6a3d10..1546693 100644
--- a/src/site/confluence/index.confluence
+++ b/src/site/confluence/index.confluence
@@ -34,5 +34,5 @@ most users, the only artifact you need is curator\-recipes.
h2. ZooKeeper Compatibility
Apache Curator is meant to be used with ZooKeeper 3.5\+. However, it is also compatible with ZooKeeper 3.4.x.
-See [[Compatibility|compatibility.html]] for details.
+See [[Compatibility|zk-compatibility.html]] for details.