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

add links to reference.conf to docs

Browse source
This commit is contained in:
Roland Kuhn 2014-03-23 18:39:55 +01:00
parent 9ed116c4bd
commit d6b33d15a8
16 changed files with 103 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

7
akka-docs/rst/dev/multi-node-testing.rst
View file

@ -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 <config-akka-multi-node-testkit>`.

18
akka-docs/rst/general/configuration.rst
View file

@ -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
~~~~~~~~~~~

14
akka-docs/rst/java/agents.rst
View file

@ -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<ValueType>(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 <config-akka-agent>`.
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.
transaction is aborted.

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

@ -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 <config-akka-camel>`.
Additional Resources
====================
For an introduction to akka-camel 2, see also the Peter Gabryanczyk's talk `Migrating akka-camel module to Akka 2.x`_.

8
akka-docs/rst/java/cluster-usage.rst
View file

@ -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 <config-akka-cluster>` for more information.
Cluster Info Logging
--------------------

7
akka-docs/rst/java/persistence.rst
View file

@ -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 <config-akka-persistence>`.

7
akka-docs/rst/java/remoting.rst
View file

@ -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 <config-akka-remote>` for more information.
.. note::

5
akka-docs/rst/java/testing.rst
View file

@ -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 <config-akka-testkit>`.

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

@ -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 <config-akka-zeromq>`.

14
akka-docs/rst/scala/agents.rst
View file

@ -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 <config-akka-agent>`.
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
.. includecode:: code/docs/agent/AgentDocSpec.scala#transfer-example

5
akka-docs/rst/scala/camel.rst
View file

@ -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 <config-akka-camel>`.
Additional Resources
====================

8
akka-docs/rst/scala/cluster-usage.rst
View file

@ -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 <config-akka-cluster>` for more information.
Cluster Info Logging
--------------------

7
akka-docs/rst/scala/persistence.rst
View file

@ -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 <config-akka-persistence>`.

7
akka-docs/rst/scala/remoting.rst
View file

@ -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 <config-akka-remote>` for more information.
.. note::

10
akka-docs/rst/scala/testing.rst
View file

@ -1,8 +1,8 @@
.. _akka-testkit:
##############################
#####################
Testing Actor Systems
##############################
#####################
.. toctree::
@ -772,3 +772,9 @@ Some `Specs2 <http://specs2.org>`_ 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 <config-akka-testkit>`.

6
akka-docs/rst/scala/zeromq.rst
View file

@ -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 <config-akka-zeromq>`.