From 0a3021eb60ebecfef99d5736706696761d72ff48 Mon Sep 17 00:00:00 2001
From: Patrik Nordwall <patrik.nordwall@gmail.com>
Date: Tue, 3 Jan 2012 10:03:58 +0100
Subject: [PATCH] DOC: Fixed wrong documentation of bounded mailbox,
 mailbox-capacity should be used, not task-queue-type. See #1601

---
 akka-actor/src/main/resources/reference.conf                | 6 ++++--
 akka-docs/java/dispatchers.rst                              | 2 +-
 .../scala/code/akka/docs/dispatcher/DispatcherDocSpec.scala | 6 ++----
 akka-docs/scala/dispatchers.rst                             | 2 +-
 4 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/akka-actor/src/main/resources/reference.conf b/akka-actor/src/main/resources/reference.conf
index 8e45379592..236eadc579 100644
--- a/akka-actor/src/main/resources/reference.conf
+++ b/akka-actor/src/main/resources/reference.conf
@@ -162,11 +162,13 @@ akka {
       # property
       # NOTE: setting a mailbox to 'blocking' can be a bit dangerous, could lead to
       # deadlock, use with care
-      # The following are only used for Dispatcher and only if mailbox-capacity > 0
+      # The following mailbox-push-timeout-time is only used for type=Dispatcher and
+      # only if mailbox-capacity > 0
       mailbox-capacity = -1
 
       # Specifies the timeout to add a new message to a mailbox that is full -
-      # negative number means infinite timeout
+      # negative number means infinite timeout. It is only used for type=Dispatcher
+      # and only if mailbox-capacity > 0
       mailbox-push-timeout-time = 10s
 
       # FQCN of the MailboxType, if not specified the default bounded or unbounded
diff --git a/akka-docs/java/dispatchers.rst b/akka-docs/java/dispatchers.rst
index 50bae0bd97..fd117f65f9 100644
--- a/akka-docs/java/dispatchers.rst
+++ b/akka-docs/java/dispatchers.rst
@@ -166,7 +166,7 @@ if not specified otherwise.
       default-dispatcher {
         # If negative (or zero) then an unbounded mailbox is used (default)
         # If positive then a bounded mailbox is used and the capacity is set to the number specified
-        task-queue-size = 1000
+        mailbox-capacity = 1000
       }
     }
   }
diff --git a/akka-docs/scala/code/akka/docs/dispatcher/DispatcherDocSpec.scala b/akka-docs/scala/code/akka/docs/dispatcher/DispatcherDocSpec.scala
index 6b4e17b63b..ba46733cbb 100644
--- a/akka-docs/scala/code/akka/docs/dispatcher/DispatcherDocSpec.scala
+++ b/akka-docs/scala/code/akka/docs/dispatcher/DispatcherDocSpec.scala
@@ -41,10 +41,8 @@ object DispatcherDocSpec {
       type = Dispatcher
       core-pool-size-factor = 8.0
       max-pool-size-factor  = 16.0
-      # Specifies the bounded capacity of the task queue
-      task-queue-size = 100
-      # Specifies which type of task queue will be used, can be "array" or "linked" (default)
-      task-queue-type = "array"
+      # Specifies the bounded capacity of the mailbox queue
+      mailbox-capacity = 100
       throughput = 3
     }
     //#my-bounded-config
diff --git a/akka-docs/scala/dispatchers.rst b/akka-docs/scala/dispatchers.rst
index 3006152c49..c9923cf459 100644
--- a/akka-docs/scala/dispatchers.rst
+++ b/akka-docs/scala/dispatchers.rst
@@ -164,7 +164,7 @@ if not specified otherwise.
       default-dispatcher {
         # If negative (or zero) then an unbounded mailbox is used (default)
         # If positive then a bounded mailbox is used and the capacity is set to the number specified
-        task-queue-size = 1000
+        mailbox-capacity = 1000
       }
     }
   }