diff --git a/akka-docs/_sphinx/static/akka-intellij-code-style.jar b/akka-docs/_sphinx/static/akka-intellij-code-style.jar new file mode 100644 index 0000000000..55866c22c5 Binary files /dev/null and b/akka-docs/_sphinx/static/akka-intellij-code-style.jar differ diff --git a/akka-docs/additional/add-on-modules.rst b/akka-docs/additional/add-on-modules.rst index bab2f1b174..981bc1ac6c 100644 --- a/akka-docs/additional/add-on-modules.rst +++ b/akka-docs/additional/add-on-modules.rst @@ -13,4 +13,4 @@ Akka Modules consist of add-on modules outside the core of Akka: - ``akka-spring-1.1.jar`` -- Spring framework integration - ``akka-osgi-dependencies-bundle-1.1.jar`` -- OSGi support -Documentation for Akka Modules is located `here `_. +Documentation for Akka Modules is located `here `_. diff --git a/akka-docs/dev/developer-guidelines.rst b/akka-docs/dev/developer-guidelines.rst index 138ff18476..be83c7bd04 100644 --- a/akka-docs/dev/developer-guidelines.rst +++ b/akka-docs/dev/developer-guidelines.rst @@ -9,7 +9,7 @@ Code Style The Akka code style follows `this document `_ . Here is a code style settings file for ``IntelliJ IDEA``: -`Download `_ +`Download <../_static/akka-intellij-code-style.jar>`_ Please follow the code style. Look at the code around you and mimic. @@ -26,7 +26,7 @@ There is a testing standard that should be followed: `Ticket001Spec `_. It enables assertions concerning replies received and their timing, there is more documentation in the ``_ module. +There is a useful test kit for testing actors: `akka.util.TestKit `_. It enables assertions concerning replies received and their timing, there is more documentation in the :ref:`akka-testkit` module. NetworkFailureTest ^^^^^^^^^^^^^^^^^^ diff --git a/akka-docs/disabled/getting-started-first.rst b/akka-docs/disabled/getting-started-first.rst index 63683a8c17..7ff96ed0ff 100644 --- a/akka-docs/disabled/getting-started-first.rst +++ b/akka-docs/disabled/getting-started-first.rst @@ -80,7 +80,7 @@ Akka is very modular and has many JARs for containing different features. The co - ``akka-slf4j-1.1.jar`` -- SLF4J Event Handler Listener - ``akka-testkit-1.1.jar`` -- Toolkit for testing Actors -We also have Akka Modules containing add-on modules outside the core of Akka. You can download the Akka Modules distribution from TODO. It contains Akka core as well. We will not be needing any modules there today, but for your information the module JARs are these: +We also have Akka Modules containing add-on modules outside the core of Akka. You can download the Akka Modules distribution from ``_. It contains Akka core as well. We will not be needing any modules there today, but for your information the module JARs are these: - ``akka-kernel-1.1.jar`` -- Akka microkernel for running a bare-bones mini application server (embeds Jetty etc.) - ``akka-amqp-1.1.jar`` -- AMQP integration diff --git a/akka-docs/index.rst b/akka-docs/index.rst index fb8e273bf5..47416d444b 100644 --- a/akka-docs/index.rst +++ b/akka-docs/index.rst @@ -24,6 +24,8 @@ Links * :ref:`scaladoc` +* `Akka Modules Documentation `_. + * :ref:`issue_tracking` * :ref:`support` diff --git a/akka-docs/intro/getting-started-first-java.rst b/akka-docs/intro/getting-started-first-java.rst index 32e8f36672..b16ba62323 100644 --- a/akka-docs/intro/getting-started-first-java.rst +++ b/akka-docs/intro/getting-started-first-java.rst @@ -102,7 +102,10 @@ Akka is very modular and has many JARs for containing different features. The co - ``akka-slf4j-1.1.jar`` -- SLF4J Event Handler Listener for logging with SLF4J - ``akka-testkit-1.1.jar`` -- Toolkit for testing Actors -We also have Akka Modules containing add-on modules outside the core of Akka. You can download the Akka Modules distribution from TODO. It contains Akka core as well. We will not be needing any modules there today, but for your information the module JARs are these: +We also have Akka Modules containing add-on modules outside the core of +Akka. You can download the Akka Modules distribution from ``_. It contains Akka +core as well. We will not be needing any modules there today, but for your +information the module JARs are these: - ``akka-kernel-1.1.jar`` -- Akka microkernel for running a bare-bones mini application server (embeds Jetty etc.) - ``akka-amqp-1.1.jar`` -- AMQP integration diff --git a/akka-docs/intro/getting-started-first-scala-eclipse.rst b/akka-docs/intro/getting-started-first-scala-eclipse.rst index b4380490ef..c30644fc01 100644 --- a/akka-docs/intro/getting-started-first-scala-eclipse.rst +++ b/akka-docs/intro/getting-started-first-scala-eclipse.rst @@ -87,7 +87,10 @@ Akka is very modular and has many JARs for containing different features. The co - ``akka-slf4j-1.1.jar`` -- SLF4J Event Handler Listener - ``akka-testkit-1.1.jar`` -- Toolkit for testing Actors -We also have Akka Modules containing add-on modules outside the core of Akka. You can download the Akka Modules distribution from TODO. It contains Akka core as well. We will not be needing any modules there today, but for your information the module JARs are these: +We also have Akka Modules containing add-on modules outside the core of +Akka. You can download the Akka Modules distribution from ``_. It contains Akka +core as well. We will not be needing any modules there today, but for your +information the module JARs are these: - ``akka-kernel-1.1.jar`` -- Akka microkernel for running a bare-bones mini application server (embeds Jetty etc.) - ``akka-amqp-1.1.jar`` -- AMQP integration diff --git a/akka-docs/intro/getting-started-first-scala.rst b/akka-docs/intro/getting-started-first-scala.rst index 07cfec7548..7fd47db7e0 100644 --- a/akka-docs/intro/getting-started-first-scala.rst +++ b/akka-docs/intro/getting-started-first-scala.rst @@ -102,7 +102,10 @@ Akka is very modular and has many JARs for containing different features. The co - ``akka-slf4j-1.1.jar`` -- SLF4J Event Handler Listener - ``akka-testkit-1.1.jar`` -- Toolkit for testing Actors -We also have Akka Modules containing add-on modules outside the core of Akka. You can download the Akka Modules distribution from TODO. It contains Akka core as well. We will not be needing any modules there today, but for your information the module JARs are these: +We also have Akka Modules containing add-on modules outside the core of +Akka. You can download the Akka Modules distribution from ``_. It contains Akka +core as well. We will not be needing any modules there today, but for your +information the module JARs are these: - ``akka-kernel-1.1.jar`` -- Akka microkernel for running a bare-bones mini application server (embeds Jetty etc.) - ``akka-amqp-1.1.jar`` -- AMQP integration diff --git a/akka-docs/java/dispatchers.rst b/akka-docs/java/dispatchers.rst index a7fe7ce19a..578fcd4ff5 100644 --- a/akka-docs/java/dispatchers.rst +++ b/akka-docs/java/dispatchers.rst @@ -129,7 +129,7 @@ Setting this to a higher number will increase throughput but lower fairness, and If you don't define a the 'throughput' option in the configuration file then the default value of '5' will be used. -Browse the `ScalaDoc `_ or look at the code for all the options available. +Browse the :ref:`scaladoc` or look at the code for all the options available. Priority event-based ^^^^^^^^^^^^^^^^^^^^ diff --git a/akka-docs/java/typed-actors.rst b/akka-docs/java/typed-actors.rst index 99803186b2..eee1ef16a0 100644 --- a/akka-docs/java/typed-actors.rst +++ b/akka-docs/java/typed-actors.rst @@ -84,7 +84,7 @@ Using a configuration object: RegistrationService service = (RegistrationService) TypedActor.newInstance(RegistrationService.class, config); -However, often you will not use these factory methods but declaratively define the Typed Actors as part of a supervisor hierarchy. More on that in the `Fault Tolerance `_ section. +However, often you will not use these factory methods but declaratively define the Typed Actors as part of a supervisor hierarchy. More on that in the :ref:`fault-tolerance-java` section. Sending messages ---------------- @@ -144,7 +144,7 @@ Here is an example: Stopping Typed Actors --------------------- -Once Typed Actors have been created with one of the TypedActor.newInstance methods they need to be stopped with TypedActor.stop to free resources allocated by the created Typed Actor (this is not needed when the Typed Actor is `supervised `_). +Once Typed Actors have been created with one of the TypedActor.newInstance methods they need to be stopped with TypedActor.stop to free resources allocated by the created Typed Actor (this is not needed when the Typed Actor is supervised). .. code-block:: java @@ -156,7 +156,7 @@ Once Typed Actors have been created with one of the TypedActor.newInstance metho // Free Typed Actor resources TypedActor.stop(service); -When the Typed Actor defines a `shutdown callback `_ method it will be invoked on TypedActor.stop. +When the Typed Actor defines a shutdown callback method (:ref:`fault-tolerance-java`) it will be invoked on TypedActor.stop. How to use the TypedActorContext for runtime information access --------------------------------------------------------------- diff --git a/akka-docs/project/scaladoc.rst b/akka-docs/project/scaladoc.rst index 312aaec5e5..deda2419b2 100644 --- a/akka-docs/project/scaladoc.rst +++ b/akka-docs/project/scaladoc.rst @@ -20,11 +20,11 @@ be found here: Release Versions ================ -1.1-RC1 -------- +1.1 +--- -- Akka 1.1-RC1 - http://akka.io/api/akka/1.1-RC1/ -- Akka Modules 1.1-RC1 - http://akka.io/api/akka-modules/1.1-RC1/ +- Akka 1.1 - http://akka.io/api/akka/1.1/ +- Akka Modules 1.1 - http://akka.io/api/akka-modules/1.1/ 1.0 --- diff --git a/akka-docs/scala/actors.rst b/akka-docs/scala/actors.rst index c7f5453a2e..bd550b807b 100644 --- a/akka-docs/scala/actors.rst +++ b/akka-docs/scala/actors.rst @@ -1,3 +1,5 @@ +.. _actors-scala: + Actors (Scala) ============== @@ -184,7 +186,7 @@ Using ``!!!`` will send a message to the receiving Actor asynchronously and will val future = actor !!! "Hello" -See `Futures `_ for more information. +See :ref:`futures-scala` for more information. Forward message ^^^^^^^^^^^^^^^ diff --git a/akka-docs/scala/dataflow.rst b/akka-docs/scala/dataflow.rst index ec99eb0a74..1262d9c089 100644 --- a/akka-docs/scala/dataflow.rst +++ b/akka-docs/scala/dataflow.rst @@ -8,7 +8,7 @@ Dataflow Concurrency (Scala) Description ----------- -Akka implements `Oz-style dataflow concurrency `_ by using a special API for `Futures `_ that allows single assignment variables and multiple lightweight (event-based) processes/threads. +Akka implements `Oz-style dataflow concurrency `_ by using a special API for :ref:`futures-scala` that allows single assignment variables and multiple lightweight (event-based) processes/threads. Dataflow concurrency is deterministic. This means that it will always behave the same. If you run it once and it yields output 5 then it will do that **every time**, run it 10 million times, same result. If it on the other hand deadlocks the first time you run it, then it will deadlock **every single time** you run it. Also, there is **no difference** between sequential code and concurrent code. These properties makes it very easy to reason about concurrency. The limitation is that the code needs to be side-effect free, e.g. deterministic. You can't use exceptions, time, random etc., but need to treat the part of your program that uses dataflow concurrency as a pure function with input and output. diff --git a/akka-docs/scala/fault-tolerance.rst b/akka-docs/scala/fault-tolerance.rst index 7276c5cdaf..c7ac83fd7e 100644 --- a/akka-docs/scala/fault-tolerance.rst +++ b/akka-docs/scala/fault-tolerance.rst @@ -1,3 +1,5 @@ +.. _fault-tolerance-scala: + Fault Tolerance Through Supervisor Hierarchies (Scala) ====================================================== diff --git a/akka-docs/scala/futures.rst b/akka-docs/scala/futures.rst index 690952baa3..7ac7f535bd 100644 --- a/akka-docs/scala/futures.rst +++ b/akka-docs/scala/futures.rst @@ -1,3 +1,5 @@ +.. _futures-scala: + Futures (Scala) =============== @@ -200,7 +202,7 @@ This is just a sample of what can be done, but to use more advanced techniques i Scalaz ^^^^^^ -Akka also has a `Scalaz module `_ for a more complete support of programming in a functional style. +Akka also has a Scalaz module (:ref:`add-on-modules`) for a more complete support of programming in a functional style. Exceptions ---------- diff --git a/akka-docs/scala/testing.rst b/akka-docs/scala/testing.rst index aeec3ac57f..eee3a2b029 100644 --- a/akka-docs/scala/testing.rst +++ b/akka-docs/scala/testing.rst @@ -1,3 +1,5 @@ +.. _akka-testkit: + ##################### Testing Actor Systems ##################### diff --git a/akka-docs/scala/tutorial-chat-server.rst b/akka-docs/scala/tutorial-chat-server.rst index 3ef4b5b74b..f54888ff31 100644 --- a/akka-docs/scala/tutorial-chat-server.rst +++ b/akka-docs/scala/tutorial-chat-server.rst @@ -36,7 +36,7 @@ Actors encapsulate state and behavior into a lightweight process/thread. In a se Creating Actors --------------- -Akka has both a `Scala API `_ and a `Java API `_. In this article we will only look at the Scala API since that is the most expressive one. The article assumes some basic Scala knowledge, but even if you don't know Scala I don't think it will not be too hard to follow along anyway. +Akka has both a Scala API (:ref:`actors-scala`) and a Java API (:ref:`untyped-actors-java`). In this article we will only look at the Scala API since that is the most expressive one. The article assumes some basic Scala knowledge, but even if you don't know Scala I don't think it will not be too hard to follow along anyway. Akka has adopted the same style of writing Actors as Erlang in which each Actor has an explicit message handler which does pattern matching to match on the incoming messages. diff --git a/akka-docs/scala/typed-actors.rst b/akka-docs/scala/typed-actors.rst index 81d68685f5..d2963ddae7 100644 --- a/akka-docs/scala/typed-actors.rst +++ b/akka-docs/scala/typed-actors.rst @@ -80,7 +80,7 @@ Using a configuration object: val service = TypedActor.newInstance(classOf[RegistrationService], classOf[RegistrationServiceImpl], config) -However, often you will not use these factory methods but declaratively define the Typed Actors as part of a supervisor hierarchy. More on that in the `Fault Tolerance `_ section. +However, often you will not use these factory methods but declaratively define the Typed Actors as part of a supervisor hierarchy. More on that in the :ref:`fault-tolerance-scala` section. Sending messages ---------------- @@ -137,7 +137,7 @@ Here is an example: Stopping Typed Actors --------------------- -Once Typed Actors have been created with one of the TypedActor.newInstance methods they need to be stopped with TypedActor.stop to free resources allocated by the created Typed Actor (this is not needed when the Typed Actor is `supervised `_). +Once Typed Actors have been created with one of the TypedActor.newInstance methods they need to be stopped with TypedActor.stop to free resources allocated by the created Typed Actor (this is not needed when the Typed Actor is supervised). .. code-block:: scala @@ -149,7 +149,7 @@ Once Typed Actors have been created with one of the TypedActor.newInstance metho // Free Typed Actor resources TypedActor.stop(service) -When the Typed Actor defines a `shutdown callback `_ method it will be invoked on TypedActor.stop. +When the Typed Actor defines a shutdown callback method (:ref:`fault-tolerance-scala`) it will be invoked on TypedActor.stop. How to use the TypedActorContext for runtime information access ---------------------------------------------------------------