diff --git a/akka-distributed-data/build.sbt b/akka-distributed-data/build.sbt index e065dffb63..5619335700 100644 --- a/akka-distributed-data/build.sbt +++ b/akka-distributed-data/build.sbt @@ -3,6 +3,8 @@ import com.typesafe.tools.mima.plugin.MimaKeys AkkaBuild.defaultSettings +AkkaBuild.experimentalSettings + Formatting.formatSettings OSGi.distributedData @@ -12,3 +14,5 @@ Dependencies.distributedData //MimaKeys.previousArtifact := akkaPreviousArtifact("akka-distributed-data").value enablePlugins(MultiNodeScalaTest) + + diff --git a/akka-docs/rst/java/distributed-data.rst b/akka-docs/rst/java/distributed-data.rst index 125f3494c7..79a4982ad6 100644 --- a/akka-docs/rst/java/distributed-data.rst +++ b/akka-docs/rst/java/distributed-data.rst @@ -24,6 +24,13 @@ It is eventually consistent and geared toward providing high read and write avai (partition tolerance), with low latency. Note that in an eventually consistent system a read may return an out-of-date value. +.. warning:: + + This module is marked as **“experimental”** as of its introduction in Akka 2.4.0. We will continue to + improve this API based on our users’ feedback, which implies that while we try to keep incompatible + changes to a minimum the binary compatibility guarantee for maintenance releases does not apply to the + contents of the ``akka.persistence`` package. + Using the Replicator ==================== @@ -502,13 +509,13 @@ To use Distributed Data you must add the following dependency in your project. sbt:: - "com.typesafe.akka" %% "akka-distributed-data" % "@version@" @crossString@ + "com.typesafe.akka" %% "akka-distributed-data-experimental" % "@version@" @crossString@ maven:: com.typesafe.akka - akka-distributed-data_@binVersion@ + akka-distributed-data-experimental_@binVersion@ @version@ diff --git a/akka-docs/rst/scala/distributed-data.rst b/akka-docs/rst/scala/distributed-data.rst index 78d14da06b..327efd9822 100644 --- a/akka-docs/rst/scala/distributed-data.rst +++ b/akka-docs/rst/scala/distributed-data.rst @@ -24,6 +24,13 @@ It is eventually consistent and geared toward providing high read and write avai (partition tolerance), with low latency. Note that in an eventually consistent system a read may return an out-of-date value. +.. warning:: + + This module is marked as **“experimental”** as of its introduction in Akka 2.4.0. We will continue to + improve this API based on our users’ feedback, which implies that while we try to keep incompatible + changes to a minimum the binary compatibility guarantee for maintenance releases does not apply to the + contents of the ``akka.persistence`` package. + Using the Replicator ==================== @@ -490,13 +497,13 @@ To use Distributed Data you must add the following dependency in your project. sbt:: - "com.typesafe.akka" %% "akka-distributed-data" % "@version@" @crossString@ + "com.typesafe.akka" %% "akka-distributed-data-experimental" % "@version@" @crossString@ maven:: com.typesafe.akka - akka-distributed-data_@binVersion@ + akka-distributed-data-experimental_@binVersion@ @version@ diff --git a/project/AkkaBuild.scala b/project/AkkaBuild.scala index e05c999f27..a4b4ec4b92 100644 --- a/project/AkkaBuild.scala +++ b/project/AkkaBuild.scala @@ -139,7 +139,7 @@ object AkkaBuild extends Build { ) configs (MultiJvm) lazy val distributedData = Project( - id = "akka-distributed-data", + id = "akka-distributed-data-experimental", base = file("akka-distributed-data"), dependencies = Seq(cluster % "compile->compile;test->test;multi-jvm->multi-jvm") ) configs (MultiJvm)