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

=doc Serialization Docs: section on verification (#22616)

Browse source 
* improve docs for serialization a bit

* fix wording in docs for serialization
This commit is contained in:
Sebastian Harko 2017-03-23 16:58:09 +01:00 • committed by Konrad `ktoso` Malawski
parent b4dbf84da8
commit ecbcc56f28
2 changed files with 4 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

10
akka-docs/rst/java/serialization.rst
View file

@ -59,23 +59,17 @@ to disable a default serializer, map its marker type to “none”::
Verification Verification
------------ ------------
If you want to verify that your messages are serializable you can enable the following config option: Normally, messages sent between local actors (i.e. same JVM) do not undergo serialization. For testing, sometimes, it may be desirable to force serialization on all messages (both remote and local). If you want to do this in order to verify that your messages are serializable you can enable the following config option:
.. includecode:: ../scala/code/docs/serialization/SerializationDocSpec.scala#serialize-messages-config .. includecode:: ../scala/code/docs/serialization/SerializationDocSpec.scala#serialize-messages-config
.. warning::
We only recommend using the config option turned on when you're running tests.
It is completely pointless to have it turned on in other scenarios.
If you want to verify that your ``Props`` are serializable you can enable the following config option: If you want to verify that your ``Props`` are serializable you can enable the following config option:
.. includecode:: ../scala/code/docs/serialization/SerializationDocSpec.scala#serialize-creators-config .. includecode:: ../scala/code/docs/serialization/SerializationDocSpec.scala#serialize-creators-config
.. warning:: .. warning::
We only recommend using the config option turned on when you're running tests. We recommend having these config options turned on **only** when you're running tests. Turning these options on in production is pointless, as it would negatively impact the performance of local message passing without giving any gain.
It is completely pointless to have it turned on in other scenarios.
Programmatic Programmatic
------------ ------------

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

@ -57,23 +57,17 @@ to disable a default serializer, map its marker type to “none”::
Verification Verification
------------ ------------
If you want to verify that your messages are serializable you can enable the following config option: Normally, messages sent between local actors (i.e. same JVM) do not undergo serialization. For testing, sometimes, it may be desirable to force serialization on all messages (both remote and local). If you want to do this in order to verify that your messages are serializable you can enable the following config option:
.. includecode:: code/docs/serialization/SerializationDocSpec.scala#serialize-messages-config .. includecode:: code/docs/serialization/SerializationDocSpec.scala#serialize-messages-config
.. warning::
We only recommend using the config option turned on when you're running tests.
It is completely pointless to have it turned on in other scenarios.
If you want to verify that your ``Props`` are serializable you can enable the following config option: If you want to verify that your ``Props`` are serializable you can enable the following config option:
.. includecode:: code/docs/serialization/SerializationDocSpec.scala#serialize-creators-config .. includecode:: code/docs/serialization/SerializationDocSpec.scala#serialize-creators-config
.. warning:: .. warning::
We only recommend using the config option turned on when you're running tests. We recommend having these config options turned on **only** when you're running tests. Turning these options on in production is pointless, as it would negatively impact the performance of local message passing without giving any gain.
It is completely pointless to have it turned on in other scenarios.
Programmatic Programmatic
------------ ------------