diff --git a/akka-docs/rst/dev/multi-node-testing.rst b/akka-docs/rst/dev/multi-node-testing.rst index c4800bd45b..6dbcd032a1 100644 --- a/akka-docs/rst/dev/multi-node-testing.rst +++ b/akka-docs/rst/dev/multi-node-testing.rst @@ -220,3 +220,10 @@ surprising ways. * Don't use MultiNodeSpec methods like address lookup, barrier entry et.c. from other threads than the main test thread. This also means that you shouldn't use them from inside an actor, a future, or a scheduled task. + +Configuration +============= + +There are several configuration properties for the Multi-Node Testing module, please refer +to the :ref:`reference configuration `. + diff --git a/akka-docs/rst/general/configuration.rst b/akka-docs/rst/general/configuration.rst index 9023479881..45a80e4635 100644 --- a/akka-docs/rst/general/configuration.rst +++ b/akka-docs/rst/general/configuration.rst @@ -416,54 +416,72 @@ Listing of the Reference Configuration Each Akka module has a reference configuration file with the default values. +.. _config-akka-actor: + akka-actor ~~~~~~~~~~ .. literalinclude:: ../../../akka-actor/src/main/resources/reference.conf :language: none +.. _config-akka-agent: + akka-agent ~~~~~~~~~~ .. literalinclude:: ../../../akka-agent/src/main/resources/reference.conf :language: none +.. _config-akka-camel: + akka-camel ~~~~~~~~~~ .. literalinclude:: ../../../akka-camel/src/main/resources/reference.conf :language: none +.. _config-akka-cluster: + akka-cluster ~~~~~~~~~~~~ .. literalinclude:: ../../../akka-cluster/src/main/resources/reference.conf :language: none +.. _config-akka-multi-node-testkit: + akka-multi-node-testkit ~~~~~~~~~~~~~~~~~~~~~~~ .. literalinclude:: ../../../akka-multi-node-testkit/src/main/resources/reference.conf :language: none +.. _config-akka-persistence: + akka-persistence ~~~~~~~~~~~~~~~~ .. literalinclude:: ../../../akka-persistence/src/main/resources/reference.conf :language: none +.. _config-akka-remote: + akka-remote ~~~~~~~~~~~ .. literalinclude:: ../../../akka-remote/src/main/resources/reference.conf :language: none +.. _config-akka-testkit: + akka-testkit ~~~~~~~~~~~~ .. literalinclude:: ../../../akka-testkit/src/main/resources/reference.conf :language: none +.. _config-akka-zeromq: + akka-zeromq ~~~~~~~~~~~ diff --git a/akka-docs/rst/java/agents.rst b/akka-docs/rst/java/agents.rst index fcb9bc24f7..34d2e0e7d1 100644 --- a/akka-docs/rst/java/agents.rst +++ b/akka-docs/rst/java/agents.rst @@ -1,8 +1,8 @@ .. _agents-java: -############## +######## Agents -############## +######## Agents in Akka are inspired by `agents in Clojure`_. @@ -26,7 +26,7 @@ dispatched to the same agent from other threads. Creating Agents -============================ +=============== Agents are created by invoking ``new Agent(value, executionContext)`` – passing in the Agent's initial value and providing an ``ExecutionContext`` to be used for it: @@ -93,6 +93,12 @@ See :ref:`futures-java` for more information on ``Futures``. :include: import-future,import-function,alter-off :language: java +Configuration +============= + +There are several configuration properties for the agents module, please refer +to the :ref:`reference configuration `. + Deprecated Transactional Agents =============================== @@ -101,4 +107,4 @@ Agents participating in enclosing STM transaction is a deprecated feature in 2.3 If an Agent is used within an enclosing ``Scala STM transaction``, then it will participate in that transaction. If you send to an Agent within a transaction then the dispatch to the Agent will be held until that transaction commits, and discarded if the -transaction is aborted. \ No newline at end of file +transaction is aborted. diff --git a/akka-docs/rst/java/camel.rst b/akka-docs/rst/java/camel.rst index b04d87b627..55e71534bb 100644 --- a/akka-docs/rst/java/camel.rst +++ b/akka-docs/rst/java/camel.rst @@ -488,6 +488,12 @@ contains 3 samples: * Quartz Scheduler Example - Showing how simple is to implement a cron-style scheduler by using the Camel Quartz component +Configuration +============= + +There are several configuration properties for the Camel module, please refer +to the :ref:`reference configuration `. + Additional Resources ==================== For an introduction to akka-camel 2, see also the Peter Gabryanczyk's talk `Migrating akka-camel module to Akka 2.x`_. diff --git a/akka-docs/rst/java/cluster-usage.rst b/akka-docs/rst/java/cluster-usage.rst index d89366fc0a..215bc3e7a3 100644 --- a/akka-docs/rst/java/cluster-usage.rst +++ b/akka-docs/rst/java/cluster-usage.rst @@ -678,12 +678,8 @@ Example of system properties to enable remote monitoring and management:: Configuration ^^^^^^^^^^^^^ -There are several configuration properties for the cluster. We refer to the following -reference file for more information: - - -.. literalinclude:: ../../../akka-cluster/src/main/resources/reference.conf - :language: none +There are several configuration properties for the cluster. We refer to the +:ref:`reference configuration ` for more information. Cluster Info Logging -------------------- diff --git a/akka-docs/rst/java/persistence.rst b/akka-docs/rst/java/persistence.rst index 0266696b1c..ce514a9826 100644 --- a/akka-docs/rst/java/persistence.rst +++ b/akka-docs/rst/java/persistence.rst @@ -679,3 +679,10 @@ or .. includecode:: ../scala/code/docs/persistence/PersistencePluginDocSpec.scala#shared-store-native-config in your Akka configuration. The LevelDB Java port is for testing purposes only. + +Configuration +============= + +There are several configuration properties for the persistence module, please refer +to the :ref:`reference configuration `. + diff --git a/akka-docs/rst/java/remoting.rst b/akka-docs/rst/java/remoting.rst index da4de5def5..c8d3729a5e 100644 --- a/akka-docs/rst/java/remoting.rst +++ b/akka-docs/rst/java/remoting.rst @@ -486,11 +486,8 @@ and related resources for troubleshooting. Remote Configuration ^^^^^^^^^^^^^^^^^^^^ -There are lots of configuration properties that are related to remoting in Akka. We refer to the following -reference file for more information: - -.. literalinclude:: ../../../akka-remote/src/main/resources/reference.conf - :language: none +There are lots of configuration properties that are related to remoting in Akka. We refer to the +:ref:`reference configuration ` for more information. .. note:: diff --git a/akka-docs/rst/java/testing.rst b/akka-docs/rst/java/testing.rst index 42a23ec65d..3c49e184d6 100644 --- a/akka-docs/rst/java/testing.rst +++ b/akka-docs/rst/java/testing.rst @@ -634,4 +634,9 @@ full logging of actor activities using this configuration fragment:: } } +Configuration +============= + +There are several configuration properties for the TestKit module, please refer +to the :ref:`reference configuration `. diff --git a/akka-docs/rst/java/zeromq.rst b/akka-docs/rst/java/zeromq.rst index c598211de1..201a3d73a7 100644 --- a/akka-docs/rst/java/zeromq.rst +++ b/akka-docs/rst/java/zeromq.rst @@ -138,3 +138,9 @@ You can create a ``Req`` connection through the:: More documentation and examples will follow soon. +Configuration +============= + +There are several configuration properties for the zeromq module, please refer +to the :ref:`reference configuration `. + diff --git a/akka-docs/rst/scala/agents.rst b/akka-docs/rst/scala/agents.rst index 58f527b5e1..0a9bff45be 100644 --- a/akka-docs/rst/scala/agents.rst +++ b/akka-docs/rst/scala/agents.rst @@ -1,8 +1,8 @@ .. _agents-scala: -################ +######## Agents -################ +######## Agents in Akka are inspired by `agents in Clojure`_. @@ -32,7 +32,7 @@ dispatched to the same agent from other threads. read or update the Agent. Creating Agents -============================ +=============== Agents are created by invoking ``Agent(value)`` passing in the Agent's initial value and providing an implicit ``ExecutionContext`` to be used for it, for these @@ -106,6 +106,12 @@ Example of monadic usage: .. includecode:: code/docs/agent/AgentDocSpec.scala#monadic-example +Configuration +============= + +There are several configuration properties for the agents module, please refer +to the :ref:`reference configuration `. + Deprecated Transactional Agents =============================== @@ -116,4 +122,4 @@ that transaction. If you send to an Agent within a transaction then the dispatch to the Agent will be held until that transaction commits, and discarded if the transaction is aborted. Here's an example: -.. includecode:: code/docs/agent/AgentDocSpec.scala#transfer-example \ No newline at end of file +.. includecode:: code/docs/agent/AgentDocSpec.scala#transfer-example diff --git a/akka-docs/rst/scala/camel.rst b/akka-docs/rst/scala/camel.rst index 35c2a5a037..5278a7f1fe 100644 --- a/akka-docs/rst/scala/camel.rst +++ b/akka-docs/rst/scala/camel.rst @@ -482,6 +482,11 @@ contains 3 samples: * Quartz Scheduler Example - Showing how simple is to implement a cron-style scheduler by using the Camel Quartz component +Configuration +============= + +There are several configuration properties for the Camel module, please refer +to the :ref:`reference configuration `. Additional Resources ==================== diff --git a/akka-docs/rst/scala/cluster-usage.rst b/akka-docs/rst/scala/cluster-usage.rst index cb6eec81d1..47a8508d9f 100644 --- a/akka-docs/rst/scala/cluster-usage.rst +++ b/akka-docs/rst/scala/cluster-usage.rst @@ -725,12 +725,8 @@ Example of system properties to enable remote monitoring and management:: Configuration ^^^^^^^^^^^^^ -There are several configuration properties for the cluster. We refer to the following -reference file for more information: - - -.. literalinclude:: ../../../akka-cluster/src/main/resources/reference.conf - :language: none +There are several configuration properties for the cluster. We refer to the +:ref:`reference configuration ` for more information. Cluster Info Logging -------------------- diff --git a/akka-docs/rst/scala/persistence.rst b/akka-docs/rst/scala/persistence.rst index 4ec3e89b75..0573645cbf 100644 --- a/akka-docs/rst/scala/persistence.rst +++ b/akka-docs/rst/scala/persistence.rst @@ -710,3 +710,10 @@ State machines State machines can be persisted by mixing in the ``FSM`` trait into processors. .. includecode:: code/docs/persistence/PersistenceDocSpec.scala#fsm-example + +Configuration +============= + +There are several configuration properties for the persistence module, please refer +to the :ref:`reference configuration `. + diff --git a/akka-docs/rst/scala/remoting.rst b/akka-docs/rst/scala/remoting.rst index 4443caa73b..1c92b42fd5 100644 --- a/akka-docs/rst/scala/remoting.rst +++ b/akka-docs/rst/scala/remoting.rst @@ -492,11 +492,8 @@ and related resources for troubleshooting. Remote Configuration ^^^^^^^^^^^^^^^^^^^^ -There are lots of configuration properties that are related to remoting in Akka. We refer to the following -reference file for more information: - -.. literalinclude:: ../../../akka-remote/src/main/resources/reference.conf - :language: none +There are lots of configuration properties that are related to remoting in Akka. We refer to the +:ref:`reference configuration ` for more information. .. note:: diff --git a/akka-docs/rst/scala/testing.rst b/akka-docs/rst/scala/testing.rst index fe61a90bf1..0995320fbb 100644 --- a/akka-docs/rst/scala/testing.rst +++ b/akka-docs/rst/scala/testing.rst @@ -1,8 +1,8 @@ .. _akka-testkit: -############################## +##################### Testing Actor Systems -############################## +##################### .. toctree:: @@ -772,3 +772,9 @@ Some `Specs2 `_ users have contributed examples of how to wor * Specifications are by default executed concurrently, which requires some care when writing the tests or alternatively the ``sequential`` keyword. +Configuration +============= + +There are several configuration properties for the TestKit module, please refer +to the :ref:`reference configuration `. + diff --git a/akka-docs/rst/scala/zeromq.rst b/akka-docs/rst/scala/zeromq.rst index aac52b985b..be2a8ef010 100644 --- a/akka-docs/rst/scala/zeromq.rst +++ b/akka-docs/rst/scala/zeromq.rst @@ -121,3 +121,9 @@ You can create a ``Req`` connection through the:: More documentation and examples will follow soon. +Configuration +============= + +There are several configuration properties for the zeromq module, please refer +to the :ref:`reference configuration `. +