From ecbcc56f28837d19da6b2d254b1bed613f408c9c Mon Sep 17 00:00:00 2001 From: Sebastian Harko Date: Thu, 23 Mar 2017 16:58:09 +0100 Subject: [PATCH] =doc Serialization Docs: section on verification (#22616) * improve docs for serialization a bit * fix wording in docs for serialization --- akka-docs/rst/java/serialization.rst | 10 ++-------- akka-docs/rst/scala/serialization.rst | 10 ++-------- 2 files changed, 4 insertions(+), 16 deletions(-) diff --git a/akka-docs/rst/java/serialization.rst b/akka-docs/rst/java/serialization.rst index 3f104ee254..1f8d64a409 100644 --- a/akka-docs/rst/java/serialization.rst +++ b/akka-docs/rst/java/serialization.rst @@ -59,23 +59,17 @@ to disable a default serializer, map its marker type to “none”:: 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 -.. 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: .. includecode:: ../scala/code/docs/serialization/SerializationDocSpec.scala#serialize-creators-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. + 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. Programmatic ------------ diff --git a/akka-docs/rst/scala/serialization.rst b/akka-docs/rst/scala/serialization.rst index b6eb9afeea..cd9e15f293 100644 --- a/akka-docs/rst/scala/serialization.rst +++ b/akka-docs/rst/scala/serialization.rst @@ -57,23 +57,17 @@ to disable a default serializer, map its marker type to “none”:: 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 -.. 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: .. includecode:: code/docs/serialization/SerializationDocSpec.scala#serialize-creators-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. + 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. Programmatic ------------