From f01db73f7f05cb90e28a1d30ba51ff6c10a25a2c Mon Sep 17 00:00:00 2001 From: Peter Vlugter Date: Fri, 6 May 2011 12:59:16 +1200 Subject: [PATCH] Fix up the migration guide --- akka-docs/general/issue-tracking.rst | 4 +- .../general/migration-guide-1.0.x-1.1.x.rst | 83 ++++++++++++++----- akka-docs/general/migration-guides.rst | 6 +- akka-docs/{pending => scala}/http.rst | 12 ++- akka-docs/scala/index.rst | 1 + 5 files changed, 74 insertions(+), 32 deletions(-) rename akka-docs/{pending => scala}/http.rst (99%) diff --git a/akka-docs/general/issue-tracking.rst b/akka-docs/general/issue-tracking.rst index b0137c3ecf..a57e2f9c99 100644 --- a/akka-docs/general/issue-tracking.rst +++ b/akka-docs/general/issue-tracking.rst @@ -28,11 +28,11 @@ In order to create tickets you need to do the following: `Register here `_ then log in For Akka tickets: -`Link to create new ticket `_ +`Link to create new ticket `__ For Akka Modules tickets: -`Link to create new ticket `_ +`Link to create new ticket `__ Thanks a lot for reporting bugs and suggesting features. diff --git a/akka-docs/general/migration-guide-1.0.x-1.1.x.rst b/akka-docs/general/migration-guide-1.0.x-1.1.x.rst index e9b27c5032..44f09ea244 100644 --- a/akka-docs/general/migration-guide-1.0.x-1.1.x.rst +++ b/akka-docs/general/migration-guide-1.0.x-1.1.x.rst @@ -1,41 +1,78 @@ -Migration Guide 1.0.x to 1.1.x -=================================== + +.. _migration-1.1: + +################################ + Migration Guide 1.0.x to 1.1.x +################################ **Akka has now moved to Scala 2.9.x** -Akka HTTP ---------- - -# akka.servlet.Initializer has been moved to ``akka-kernel`` to be able to have ``akka-http`` not depend on ``akka-remote``, if you don't want to use the class for kernel, just create your own version of ``akka.servlet.Initializer``, it's just a couple of lines of code and there is instructions here: `Akka Http Docs `_ -# akka.http.ListWriter has been removed in full, if you use it and want to keep using it, here's the code: `ListWriter `_ -# Jersey-server is now a "provided" dependency for ``akka-http``, so you'll need to add the dependency to your project, it's built against Jersey 1.3 - Akka Actor ----------- +========== -# is now dependency free, with the exception of the dependency on the ``scala-library.jar`` -# does not bundle any logging anymore, but you can subscribe to events within Akka by registering an event handler on akka.event.EventHandler or by specifying the ``FQN`` of an Actor in the akka.conf under akka.event-handlers; there is an ``akka-slf4j`` module which still provides the Logging trait and a default ``SLF4J`` logger adapter. -Don't forget to add a SLF4J backend though, we recommend: +- is now dependency free, with the exception of the dependency on the + ``scala-library.jar`` -.. code-block:: scala +- does not bundle any logging anymore, but you can subscribe to events within + Akka by registering an event handler on akka.event.EventHandler or by specifying + the ``FQN`` of an Actor in the akka.conf under akka.event-handlers; there is an + ``akka-slf4j`` module which still provides the Logging trait and a default + ``SLF4J`` logger adapter. - lazy val logback = "ch.qos.logback" % "logback-classic" % "0.9.28" % "runtime" + Don't forget to add a SLF4J backend though, we recommend: + + .. code-block:: scala + + lazy val logback = "ch.qos.logback" % "logback-classic" % "0.9.28" % "runtime" + +- If you used HawtDispatcher and want to continue using it, you need to include + akka-dispatcher-extras.jar from Akka Modules, in your akka.conf you need to + specify: ``akka.dispatch.HawtDispatcherConfigurator`` instead of + ``HawtDispatcher`` + +- FSM: the onTransition method changed from Function1 to PartialFunction; there + is an implicit conversion for the precise types in place, but it may be + necessary to add an underscore if you are passing an eta-expansion (using a + method as function value). -# If you used HawtDispatcher and want to continue using it, you need to include akka-dispatcher-extras.jar from Akka Modules, in your akka.conf you need to specify: ``akka.dispatch.HawtDispatcherConfigurator`` instead of ``HawtDispatcher`` -# FSM: the onTransition method changed from Function1 to PartialFunction; there is an implicit conversion for the precise types in place, but it may be necessary to add an underscore if you are passing an eta-expansion (using a method as function value). Akka Typed Actor ----------------- +================ + +- All methods starting with ``get*`` are deprecated and will be removed in post + 1.1 release. + -All methods starting with 'get*' are deprecated and will be removed in post 1.1 release. Akka Remote ------------ +=========== + +- ``UnparsebleException`` has been renamed to + ``CannotInstantiateRemoteExceptionDueToRemoteProtocolParsingErrorException(exception, + classname, message)`` + + +Akka HTTP +========= + +- akka.servlet.Initializer has been moved to ``akka-kernel`` to be able to have + ``akka-http`` not depend on ``akka-remote``. If you don't want to use the class + for kernel, just create your own version of ``akka.servlet.Initializer``, it's + just a couple of lines of code and there are instructions in + the :ref:`http-module` docs. + +- akka.http.ListWriter has been removed in full, if you use it and want to keep + using it, here's the code: `ListWriter`_. + +- Jersey-server is now a "provided" dependency for ``akka-http``, so you'll need + to add the dependency to your project, it's built against Jersey 1.3 + +.. _ListWriter: https://github.com/jboner/akka/blob/v1.0/akka-http/src/main/scala/akka/http/ListWriter.scala -# ``UnparsebleException`` has been renamed to ``CannotInstantiateRemoteExceptionDueToRemoteProtocolParsingErrorException(exception, classname, message)`` Akka Testkit ------------- +============ -The TestKit moved into the akka-testkit subproject and correspondingly into the ``akka.testkit`` package. +- The TestKit moved into the akka-testkit subproject and correspondingly into the + ``akka.testkit`` package. diff --git a/akka-docs/general/migration-guides.rst b/akka-docs/general/migration-guides.rst index ed9c1de270..31e0593f71 100644 --- a/akka-docs/general/migration-guides.rst +++ b/akka-docs/general/migration-guides.rst @@ -4,7 +4,7 @@ Migration Guides .. toctree:: :maxdepth: 1 - migration-guide-0.7.x-0.8.x - migration-guide-0.8.x-0.9.x - migration-guide-0.9.x-0.10.x migration-guide-1.0.x-1.1.x + migration-guide-0.9.x-0.10.x + migration-guide-0.8.x-0.9.x + migration-guide-0.7.x-0.8.x diff --git a/akka-docs/pending/http.rst b/akka-docs/scala/http.rst similarity index 99% rename from akka-docs/pending/http.rst rename to akka-docs/scala/http.rst index 9de34d05e7..75bd9ca7c9 100644 --- a/akka-docs/pending/http.rst +++ b/akka-docs/scala/http.rst @@ -1,10 +1,14 @@ -HTTP -==== + +.. _http-module: + +###### + HTTP +###### Module stability: **SOLID** -When using Akkas embedded servlet container: --------------------------------------------- +When using Akkas embedded servlet container +------------------------------------------- Akka supports the JSR for REST called JAX-RS (JSR-311). It allows you to create interaction with your actors through HTTP + REST diff --git a/akka-docs/scala/index.rst b/akka-docs/scala/index.rst index 99d460aa94..530d125fa2 100644 --- a/akka-docs/scala/index.rst +++ b/akka-docs/scala/index.rst @@ -17,5 +17,6 @@ Scala API fault-tolerance dispatchers fsm + http testing tutorial-chat-server