Bug 136943 [console] README: Console Deadlock when too much information written

4 files changed, 24 insertions, 2 deletions

diff --git a/org.eclipse.ui.console/src/org/eclipse/ui/console/IOConsole.java b/org.eclipse.ui.console/src/org/eclipse/ui/console/IOConsole.java
index b4c0506db..b770ff09e 100644
--- a/org.eclipse.ui.console/src/org/eclipse/ui/console/IOConsole.java
+++ b/org.eclipse.ui.console/src/org/eclipse/ui/console/IOConsole.java
@@ -126,7 +126,12 @@ public class IOConsole extends TextConsole {
      * Creates and returns a new output stream which may be used to write to this console.
      * A console may be connected to more than one output stream at once. Clients are
      * responsible for closing any output streams created on this console.
-     * 
+     * <p>
+     * Clients should avoid writing large amounts of output to this stream in the UI
+     * thread. The console needs to process the output in the UI thread and if the client
+     * hogs the UI thread writing output to the console, the console will not be able
+     * to process the output.
+     * </p>
      * @return a new output stream connected to this console
      */
     public IOConsoleOutputStream newOutputStream() {
diff --git a/org.eclipse.ui.console/src/org/eclipse/ui/console/IOConsoleOutputStream.java b/org.eclipse.ui.console/src/org/eclipse/ui/console/IOConsoleOutputStream.java
index 5b18216fa..8093506e8 100644
--- a/org.eclipse.ui.console/src/org/eclipse/ui/console/IOConsoleOutputStream.java
+++ b/org.eclipse.ui.console/src/org/eclipse/ui/console/IOConsoleOutputStream.java
@@ -24,6 +24,12 @@ import org.eclipse.ui.internal.console.IOConsolePartitioner;
  * use <code>IOConsole.newOutputStream()</code>. Clients are not intended
  * to subclass this class.
  * </p>
+ * <p>
+ * Clients should avoid writing large amounts of output to this stream in the UI
+ * thread. The console needs to process the output in the UI thread and if the client
+ * hogs the UI thread writing output to the console, the console will not be able
+ * to process the output.
+ * </p>
  * @since 3.1
  */
 public class IOConsoleOutputStream extends OutputStream {
diff --git a/org.eclipse.ui.console/src/org/eclipse/ui/console/MessageConsole.java b/org.eclipse.ui.console/src/org/eclipse/ui/console/MessageConsole.java
index 961203c91..500189641 100644
--- a/org.eclipse.ui.console/src/org/eclipse/ui/console/MessageConsole.java
+++ b/org.eclipse.ui.console/src/org/eclipse/ui/console/MessageConsole.java
@@ -79,7 +79,12 @@ public class MessageConsole extends IOConsole {
 		
 	/**
 	 * Returns a new message stream connected to this console.
-	 * 
+	 * <p>
+     * Clients should avoid writing large amounts of output to this stream in the UI
+     * thread. The console needs to process the output in the UI thread and if the client
+     * hogs the UI thread writing output to the console, the console will not be able
+     * to process the output.
+     * </p>
 	 * @return a new message stream connected to this console
 	 */
 	public MessageConsoleStream newMessageStream() {
diff --git a/org.eclipse.ui.console/src/org/eclipse/ui/console/MessageConsoleStream.java b/org.eclipse.ui.console/src/org/eclipse/ui/console/MessageConsoleStream.java
index 9160ddac6..af50ac87c 100644
--- a/org.eclipse.ui.console/src/org/eclipse/ui/console/MessageConsoleStream.java
+++ b/org.eclipse.ui.console/src/org/eclipse/ui/console/MessageConsoleStream.java
@@ -21,6 +21,12 @@ import java.io.IOException;
  * are created via a {@link org.eclipse.ui.console.MessageConsole}.
  * </p>
  * <p>
+ * Clients should avoid writing large amounts of output to this stream in the UI
+ * thread. The console needs to process the output in the UI thread and if the client
+ * hogs the UI thread writing output to the console, the console will not be able
+ * to process the output.
+ * </p>
+ * <p>
  * Since 3.1, this class extends {@link org.eclipse.ui.console.IOConsoleOutputStream}.
  * </p>
  * @since 3.0