logging-log4j2 git commit: Document that the terminate method is blocking.

[mi...@apache.org]

Repository: logging-log4j2
Updated Branches:
  refs/heads/master 0832abc15 -> f3528af81


Document that the terminate method is blocking.


Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/f3528af8
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/f3528af8
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/f3528af8

Branch: refs/heads/master
Commit: f3528af81d0628ae7a256644ad3b94e27446be22
Parents: 0832abc
Author: Mikael Ståldal <mi...@magine.com>
Authored: Wed Jan 27 10:20:05 2016 +0100
Committer: Mikael Ståldal <mi...@magine.com>
Committed: Wed Jan 27 10:20:05 2016 +0100

----------------------------------------------------------------------
 .../src/main/java/org/apache/logging/log4j/spi/Terminable.java    | 3 +++
 1 file changed, 3 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/f3528af8/log4j-api/src/main/java/org/apache/logging/log4j/spi/Terminable.java
----------------------------------------------------------------------
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/spi/Terminable.java b/log4j-api/src/main/java/org/apache/logging/log4j/spi/Terminable.java
index 53ed313..1a8abe6 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/spi/Terminable.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/spi/Terminable.java
@@ -12,6 +12,9 @@ public interface Terminable {
 
     /**
      * Requests that the logging implementation shut down.
+     *
+     * This call is synchronous and will block until shut down is complete.
+     * This may include flushing pending log events over network connections.
      */
     void terminate();
 }