tinkerpop-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ok...@apache.org
Subject [12/15] incubator-tinkerpop git commit: Updated upgrade docs about traversal cancellation.
Date Wed, 04 May 2016 19:48:57 GMT
Updated upgrade docs about traversal cancellation.


Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/8fd0bae0
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/8fd0bae0
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/8fd0bae0

Branch: refs/heads/TINKERPOP-1288
Commit: 8fd0bae0fb91e2f1b911b6dc1623d0482b018070
Parents: a447a24
Author: Stephen Mallette <spmva@genoprime.com>
Authored: Wed May 4 07:00:11 2016 -0400
Committer: Stephen Mallette <spmva@genoprime.com>
Committed: Wed May 4 07:00:11 2016 -0400

----------------------------------------------------------------------
 .../upgrade/release-3.2.x-incubating.asciidoc   | 32 ++++++++++++++++++--
 1 file changed, 30 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/8fd0bae0/docs/src/upgrade/release-3.2.x-incubating.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/upgrade/release-3.2.x-incubating.asciidoc b/docs/src/upgrade/release-3.2.x-incubating.asciidoc
index 7772e0f..0d5836d 100644
--- a/docs/src/upgrade/release-3.2.x-incubating.asciidoc
+++ b/docs/src/upgrade/release-3.2.x-incubating.asciidoc
@@ -27,13 +27,25 @@ TinkerPop 3.2.1
 
 *Release Date: NOT OFFICIALLY RELEASED YET*
 
-Please see the link:https://github.com/apache/incubator-tinkerpop/blob/3.2.1-incubating/CHANGELOG.asciidoc#tinkerpop-313-release-date-MONTH-DAY-YEAR[changelog]
for a complete list of all the modifications that are part of this release.
+Please see the link:https://github.com/apache/incubator-tinkerpop/blob/3.2.1-incubating/CHANGELOG.asciidoc#tinkerpop-321-release-date-MONTH-DAY-YEAR[changelog]
for a complete list of all the modifications that are part of this release.
 
 Upgrading for Users
 ~~~~~~~~~~~~~~~~~~~
 
+Interrupting Traversals
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Traversals now better respect calls to `Thread.interrupt()`, which mean that a running `Traversal`
can now be
+cancelled. There are some limitations that remain, but most OLTP-based traversals should
cancel without
+issue. OLAP-based traversals for Spark will also cancel and clean up running jobs in Spark
itself. Mileage may vary
+on other process implementations and it is possible that graph providers could potentially
write custom step
+implementations that prevent interruption. If it is found that there are configurations or
specific traversals that
+do not respect interruption, please mention them on the mailing list.
+
+See: https://issues.apache.org/jira/browse/TINKERPOP-946[TINKERPOP-946]
+
 Gremlin Console Flags
-+++++++++++++++++++++
+^^^^^^^^^^^^^^^^^^^^^
 
 Gremlin Console had several methods for executing scripts from file at the start-up of `bin/gremlin.sh`.
There were
 two options:
@@ -71,6 +83,22 @@ link:https://issues.apache.org/jira/browse/TINKERPOP-1157[TINKERPOP-1157],
 link:http://tinkerpop.apache.org/docs/3.2.1-incubating/reference/#interactive-mode[Reference
Documentation - Interactive Mode],
 link:http://tinkerpop.apache.org/docs/3.2.1-incubating/reference/#execution-mode[Reference
Documentation - Execution Mode]
 
+Upgrading for Providers
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Graph System Providers
+^^^^^^^^^^^^^^^^^^^^^^
+
+Interrupting Traversals
++++++++++++++++++++++++
+
+Several tests have been added to the TinkerPop test suite to validate that a `Traversal`
can be cancelled with
+`Thread.interrupt()`. The test suite does not cover all possible traversal scenarios. When
implementing custom steps,
+providers should take care to not ignore an `InterruptionException` that might be thrown
in their code and to be sure
+to check `Thread.isInterrupted()` as needed to ensure that the step remains cancellation
compliant.
+
+See: https://issues.apache.org/jira/browse/TINKERPOP-946[TINKERPOP-946]
+
 TinkerPop 3.2.0
 ---------------
 


Mime
View raw message