raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 11

Fix various small things in docs, see #2707

Browse source 
* Forward port of 2.0.3 erratai,
  commit 93883896b6602341cc001e292f000a93a53d6885
(cherry picked from commit 0025332473518eb7e6606f7923286aacbec8727c)
This commit is contained in:
Patrik Nordwall 2012-11-20 17:53:59 +01:00
parent b06b0fa087
commit c736c9ea5e
7 changed files with 11 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

8
akka-docs/rst/general/jmm.rst
View file

@ -13,9 +13,9 @@ Prior to Java 5, the Java Memory Model (JMM) was ill defined. It was possible to
shared memory was accessed by multiple threads, such as: shared memory was accessed by multiple threads, such as:
* a thread not seeing values written by other threads: a visibility problem * a thread not seeing values written by other threads: a visibility problem
* a thread observing 'impossible' behavior of other threads, caused by instructions not being executed in the order * a thread observing 'impossible' behavior of other threads, caused by
instructions not being executed in the order expected: an instruction
expected: an instruction reordering problem. reordering problem.
With the implementation of JSR 133 in Java 5, a lot of these issues have been resolved. The JMM is a set of rules based With the implementation of JSR 133 in Java 5, a lot of these issues have been resolved. The JMM is a set of rules based
on the "happens-before" relation, which constrain when one memory access must happen before another, and conversely, on the "happens-before" relation, which constrain when one memory access must happen before another, and conversely,
@ -120,4 +120,4 @@ Since Akka runs on the JVM there are still some rules to be followed.
} }
} }
* Messages **should** be immutable, this is to avoid the shared mutable state trap. * Messages **should** be immutable, this is to avoid the shared mutable state trap.

2
akka-docs/rst/intro/why-akka.rst
View file

@ -24,7 +24,7 @@ and then there's the whole package, the Akka Microkernel, which is a standalone
container to deploy your Akka application in. With CPUs growing more and more container to deploy your Akka application in. With CPUs growing more and more
cores every cycle, Akka is the alternative that provides outstanding performance cores every cycle, Akka is the alternative that provides outstanding performance
even if you're only running it on one machine. Akka also supplies a wide array even if you're only running it on one machine. Akka also supplies a wide array
of concurrency-paradigms, allowing for users to choose the right tool for the of concurrency-paradigms, allowing users to choose the right tool for the
job. job.

2
akka-docs/rst/java/event-bus.rst
View file

@ -185,7 +185,7 @@ at runtime::
system.eventStream.setLogLevel(Logging.DebugLevel()); system.eventStream.setLogLevel(Logging.DebugLevel());
This means that log events for a level which will not be logged are not This means that log events for a level which will not be logged are
typically not dispatched at all (unless manual subscriptions to the respective typically not dispatched at all (unless manual subscriptions to the respective
event class have been done) event class have been done)

3
akka-docs/rst/java/fault-tolerance.rst
View file

@ -24,9 +24,6 @@ sample as it is easy to follow the log output to understand what is happening in
fault-tolerance-sample fault-tolerance-sample
.. includecode:: code/docs/actor/japi/FaultHandlingDocSample.java#all
:exclude: imports,messages,dummydb
Creating a Supervisor Strategy Creating a Supervisor Strategy
------------------------------ ------------------------------

6
akka-docs/rst/java/routing.rst
View file

@ -66,7 +66,7 @@ In addition to being able to supply looked-up remote actors as routees, you can
make the router deploy its created children on a set of remote hosts; this will make the router deploy its created children on a set of remote hosts; this will
be done in round-robin fashion. In order to do that, wrap the router be done in round-robin fashion. In order to do that, wrap the router
configuration in a :class:`RemoteRouterConfig`, attaching the remote addresses of configuration in a :class:`RemoteRouterConfig`, attaching the remote addresses of
the nodes to deploy to. Naturally, this requires your to include the the nodes to deploy to. Naturally, this requires you to include the
``akka-remote`` module on your classpath: ``akka-remote`` module on your classpath:
.. includecode:: code/docs/jrouting/RouterViaProgramExample.java#remoteRoutees .. includecode:: code/docs/jrouting/RouterViaProgramExample.java#remoteRoutees
@ -114,7 +114,7 @@ Routers vs. Supervision
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
As explained in the previous section, routers create new actor instances as As explained in the previous section, routers create new actor instances as
children of the “head” router, who therefor also is their supervisor. The children of the “head” router, who therefore also is their supervisor. The
supervisor strategy of this actor can be configured by means of the supervisor strategy of this actor can be configured by means of the
:meth:`RouterConfig.supervisorStrategy` property, which is supported for all :meth:`RouterConfig.supervisorStrategy` property, which is supported for all
built-in router types. It defaults to “always escalate”, which leads to the built-in router types. It defaults to “always escalate”, which leads to the
@ -434,7 +434,7 @@ Configured Custom Router
It is possible to define configuration properties for custom routers. In the ``router`` property of the deployment It is possible to define configuration properties for custom routers. In the ``router`` property of the deployment
configuration you define the fully qualified class name of the router class. The router class must extend configuration you define the fully qualified class name of the router class. The router class must extend
``akka.routing.CustomRouterConfig`` and and have constructor with ``com.typesafe.config.Config`` parameter. ``akka.routing.CustomRouterConfig`` and have constructor with one ``com.typesafe.config.Config`` parameter.
The deployment section of the configuration is passed to the constructor. The deployment section of the configuration is passed to the constructor.
Custom Resizer Custom Resizer

3
akka-docs/rst/scala/fault-tolerance.rst
View file

@ -24,9 +24,6 @@ sample as it is easy to follow the log output to understand what is happening in
fault-tolerance-sample fault-tolerance-sample
.. includecode:: code/docs/actor/FaultHandlingDocSample.scala#all
:exclude: imports,messages,dummydb
Creating a Supervisor Strategy Creating a Supervisor Strategy
------------------------------ ------------------------------

4
akka-docs/rst/scala/routing.rst
View file

@ -66,7 +66,7 @@ In addition to being able to supply looked-up remote actors as routees, you can
make the router deploy its created children on a set of remote hosts; this will make the router deploy its created children on a set of remote hosts; this will
be done in round-robin fashion. In order to do that, wrap the router be done in round-robin fashion. In order to do that, wrap the router
configuration in a :class:`RemoteRouterConfig`, attaching the remote addresses of configuration in a :class:`RemoteRouterConfig`, attaching the remote addresses of
the nodes to deploy to. Naturally, this requires your to include the the nodes to deploy to. Naturally, this requires you to include the
``akka-remote`` module on your classpath: ``akka-remote`` module on your classpath:
.. includecode:: code/docs/routing/RouterViaProgramExample.scala#remoteRoutees .. includecode:: code/docs/routing/RouterViaProgramExample.scala#remoteRoutees
@ -430,7 +430,7 @@ Configured Custom Router
It is possible to define configuration properties for custom routers. In the ``router`` property of the deployment It is possible to define configuration properties for custom routers. In the ``router`` property of the deployment
configuration you define the fully qualified class name of the router class. The router class must extend configuration you define the fully qualified class name of the router class. The router class must extend
``akka.routing.RouterConfig`` and and have constructor with ``com.typesafe.config.Config`` parameter. ``akka.routing.RouterConfig`` and have constructor with one ``com.typesafe.config.Config`` parameter.
The deployment section of the configuration is passed to the constructor. The deployment section of the configuration is passed to the constructor.
Custom Resizer Custom Resizer