From d66529793164082e5634c61db8e3f3bba249249a Mon Sep 17 00:00:00 2001 From: Peter Vlugter Date: Fri, 16 Dec 2011 12:12:03 +1300 Subject: [PATCH 1/4] Fix remaining warnings in docs generation --- akka-docs/additional/index.rst | 2 +- akka-docs/additional/{recipies.rst => recipes.rst} | 4 ++-- akka-docs/{additional => disabled}/articles.rst | 0 .../{additional => disabled}/external-sample-projects.rst | 0 akka-docs/intro/getting-started.rst | 3 +-- akka-docs/java/extending-akka.rst | 4 ++-- akka-docs/java/index.rst | 1 + akka-docs/java/remoting.rst | 4 ++-- akka-docs/java/typed-actors.rst | 4 ++-- akka-docs/scala/extending-akka.rst | 4 ++-- akka-docs/scala/index.rst | 2 ++ akka-docs/scala/remoting.rst | 4 ++-- 12 files changed, 17 insertions(+), 15 deletions(-) rename akka-docs/additional/{recipies.rst => recipes.rst} (78%) rename akka-docs/{additional => disabled}/articles.rst (100%) rename akka-docs/{additional => disabled}/external-sample-projects.rst (100%) diff --git a/akka-docs/additional/index.rst b/akka-docs/additional/index.rst index fd3da0f898..f108deef51 100644 --- a/akka-docs/additional/index.rst +++ b/akka-docs/additional/index.rst @@ -5,7 +5,7 @@ Additional Information :maxdepth: 2 benchmarks - recipies + recipes companies-using-akka third-party-integrations language-bindings diff --git a/akka-docs/additional/recipies.rst b/akka-docs/additional/recipes.rst similarity index 78% rename from akka-docs/additional/recipies.rst rename to akka-docs/additional/recipes.rst index 55bc4085a1..eff333cb28 100644 --- a/akka-docs/additional/recipies.rst +++ b/akka-docs/additional/recipes.rst @@ -1,5 +1,5 @@ -Here is a list of recipies for all things Akka -============================================== +Here is a list of recipes for all things Akka +============================================= * PostStart => `Link to Klangism `_ * `Consumer actors best practices `_ diff --git a/akka-docs/additional/articles.rst b/akka-docs/disabled/articles.rst similarity index 100% rename from akka-docs/additional/articles.rst rename to akka-docs/disabled/articles.rst diff --git a/akka-docs/additional/external-sample-projects.rst b/akka-docs/disabled/external-sample-projects.rst similarity index 100% rename from akka-docs/additional/external-sample-projects.rst rename to akka-docs/disabled/external-sample-projects.rst diff --git a/akka-docs/intro/getting-started.rst b/akka-docs/intro/getting-started.rst index 3f43390c17..16a4a46c2f 100644 --- a/akka-docs/intro/getting-started.rst +++ b/akka-docs/intro/getting-started.rst @@ -58,8 +58,7 @@ external dependencies (apart from the ``scala-library.jar`` JAR). Using a release distribution ---------------------------- -Download the release you need, Akka Actors, Akka Core, or Akka Microkernel, from -http://akka.io/downloads and unzip it. +Download the release you need from http://akka.io/downloads and unzip it. Using a snapshot version ------------------------ diff --git a/akka-docs/java/extending-akka.rst b/akka-docs/java/extending-akka.rst index 7cc46cc93d..edbea859b1 100644 --- a/akka-docs/java/extending-akka.rst +++ b/akka-docs/java/extending-akka.rst @@ -1,4 +1,4 @@ -.. _extending-akka: +.. _extending-akka-java: Akka Extensions =============== @@ -60,4 +60,4 @@ Applicability ------------- The sky is the limit! -By the way, did you know that Akka's ``Typed Actors``, ``Serialization`` and other features are implemented as Akka Extensions? \ No newline at end of file +By the way, did you know that Akka's ``Typed Actors``, ``Serialization`` and other features are implemented as Akka Extensions? diff --git a/akka-docs/java/index.rst b/akka-docs/java/index.rst index fbc94dbc61..8ae79c5ba4 100644 --- a/akka-docs/java/index.rst +++ b/akka-docs/java/index.rst @@ -18,3 +18,4 @@ Java API remoting serialization extending-akka + transactors diff --git a/akka-docs/java/remoting.rst b/akka-docs/java/remoting.rst index 15eacc3f4c..1599d02ff8 100644 --- a/akka-docs/java/remoting.rst +++ b/akka-docs/java/remoting.rst @@ -82,7 +82,7 @@ For more information please see :ref:`serialization-java` Routers with Remote Destinations ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -It is absolutely feasible to combine remoting with :ref:`routers`. +It is absolutely feasible to combine remoting with :ref:`routing-java`. This is also done via configuration:: akka { @@ -100,4 +100,4 @@ This is also done via configuration:: } This configuration setting will clone the actor “aggregation” 10 times and deploy it evenly distributed across -the two given target nodes. \ No newline at end of file +the two given target nodes. diff --git a/akka-docs/java/typed-actors.rst b/akka-docs/java/typed-actors.rst index d857ac509d..4b7de5ee09 100644 --- a/akka-docs/java/typed-actors.rst +++ b/akka-docs/java/typed-actors.rst @@ -1,5 +1,5 @@ -Typed Actors (Scala) -==================== +Typed Actors (Java) +=================== .. sidebar:: Contents diff --git a/akka-docs/scala/extending-akka.rst b/akka-docs/scala/extending-akka.rst index a13326b626..6a1655db01 100644 --- a/akka-docs/scala/extending-akka.rst +++ b/akka-docs/scala/extending-akka.rst @@ -1,4 +1,4 @@ -.. _extending-akka: +.. _extending-akka-scala: Akka Extensions =============== @@ -50,4 +50,4 @@ Applicability ------------- The sky is the limit! -By the way, did you know that Akka's ``Typed Actors``, ``Serialization`` and other features are implemented as Akka Extensions? \ No newline at end of file +By the way, did you know that Akka's ``Typed Actors``, ``Serialization`` and other features are implemented as Akka Extensions? diff --git a/akka-docs/scala/index.rst b/akka-docs/scala/index.rst index 898a74f905..54139db119 100644 --- a/akka-docs/scala/index.rst +++ b/akka-docs/scala/index.rst @@ -20,3 +20,5 @@ Scala API fsm testing extending-akka + agents + transactors diff --git a/akka-docs/scala/remoting.rst b/akka-docs/scala/remoting.rst index 78f7a598ad..86c0ccf1c1 100644 --- a/akka-docs/scala/remoting.rst +++ b/akka-docs/scala/remoting.rst @@ -86,7 +86,7 @@ For more information please see :ref:`serialization-scala` Routers with Remote Destinations ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -It is absolutely feasible to combine remoting with :ref:`routers`. +It is absolutely feasible to combine remoting with :ref:`routing-scala`. This is also done via configuration:: akka { @@ -104,4 +104,4 @@ This is also done via configuration:: } This configuration setting will clone the actor “aggregation” 10 times and deploy it evenly distributed across -the two given target nodes. \ No newline at end of file +the two given target nodes. From 2e988c83725208126663b1d92feefab3ec2e5fc2 Mon Sep 17 00:00:00 2001 From: Roland Date: Fri, 16 Dec 2011 00:03:12 +0100 Subject: [PATCH 2/4] polish TestKit (add new assertions) --- akka-docs/scala/testing.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/akka-docs/scala/testing.rst b/akka-docs/scala/testing.rst index c459e9055f..ce2a175cd6 100644 --- a/akka-docs/scala/testing.rst +++ b/akka-docs/scala/testing.rst @@ -281,6 +281,13 @@ assertions concerning received messages. Here is the full list: ``n`` messages must be received within the given time; the received messages are returned. + * :meth:`fishForMessage(max: Duration, hint: String)(pf: PartialFunction[Any, Boolean]): Any` + + Keep receiving messages as long as the time is not used up and the partial + function matches and returns ``false``. Returns the message received for + which it returned ``true`` or throws an exception, which will include the + provided hint for easier debugging. + In addition to message reception assertions there are also methods which help with message flows: @@ -290,18 +297,20 @@ with message flows: returns ``null`` in case of failure. If the given Duration is zero, the call is non-blocking (polling mode). - * :meth:`receiveWhile[T](max: Duration, idle: Duration)(pf: PartialFunction[Any, T]): Seq[T]` + * :meth:`receiveWhile[T](max: Duration, idle: Duration, messages: Int)(pf: PartialFunction[Any, T]): Seq[T]` Collect messages as long as * they are matching the given partial function * the given time interval is not used up * the next message is received within the idle timeout + * the number of messages has not yet reached the maximum All collected messages are returned. The maximum duration defaults to the time remaining in the innermost enclosing :ref:`within ` block and the idle duration defaults to infinity (thereby disabling the - idle timeout feature). + idle timeout feature). The number of expected messages defaults to + ``Int.MaxValue``, which effectively disables this limit. * :meth:`awaitCond(p: => Boolean, max: Duration, interval: Duration)` From 1f62b8d08a42899eca35df803e1c19e4b45dd577 Mon Sep 17 00:00:00 2001 From: Peter Vlugter Date: Fri, 16 Dec 2011 12:21:22 +1300 Subject: [PATCH 3/4] Disable amqp module as there currently isn't anything there --- project/AkkaBuild.scala | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/project/AkkaBuild.scala b/project/AkkaBuild.scala index 4a4685113b..0776b584a7 100644 --- a/project/AkkaBuild.scala +++ b/project/AkkaBuild.scala @@ -30,7 +30,7 @@ object AkkaBuild extends Build { Unidoc.unidocExclude := Seq(samples.id, tutorials.id), Dist.distExclude := Seq(actorTests.id, akkaSbtPlugin.id, docs.id) ), - aggregate = Seq(actor, testkit, actorTests, remote, slf4j, amqp, mailboxes, kernel, akkaSbtPlugin, samples, tutorials, docs) + aggregate = Seq(actor, testkit, actorTests, remote, slf4j, mailboxes, kernel, akkaSbtPlugin, samples, tutorials, docs) ) lazy val actor = Project( @@ -92,14 +92,14 @@ object AkkaBuild extends Build { ) ) - lazy val amqp = Project( - id = "akka-amqp", - base = file("akka-amqp"), - dependencies = Seq(actor, testkit % "test->test"), - settings = defaultSettings ++ Seq( - libraryDependencies ++= Dependencies.amqp - ) - ) + // lazy val amqp = Project( + // id = "akka-amqp", + // base = file("akka-amqp"), + // dependencies = Seq(actor, testkit % "test->test"), + // settings = defaultSettings ++ Seq( + // libraryDependencies ++= Dependencies.amqp + // ) + // ) lazy val mailboxes = Project( id = "akka-durable-mailboxes", From f6511db38437e0df59220976dd7fbac17370994d Mon Sep 17 00:00:00 2001 From: Peter Vlugter Date: Fri, 16 Dec 2011 12:29:32 +1300 Subject: [PATCH 4/4] Formatting after compile --- akka-actor/src/main/scala/akka/actor/ActorCell.scala | 1 - 1 file changed, 1 deletion(-) diff --git a/akka-actor/src/main/scala/akka/actor/ActorCell.scala b/akka-actor/src/main/scala/akka/actor/ActorCell.scala index 7f5246f8fa..23cd67d784 100644 --- a/akka-actor/src/main/scala/akka/actor/ActorCell.scala +++ b/akka-actor/src/main/scala/akka/actor/ActorCell.scala @@ -14,7 +14,6 @@ import akka.util.{ Duration, Helpers } import akka.japi.Procedure import java.io.{ NotSerializableException, ObjectOutputStream } - //TODO: everything here for current compatibility - could be limited more /**