You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2015/10/13 18:34:03 UTC
incubator-tinkerpop git commit: Add the 3.1.x upgrade doc.
Repository: incubator-tinkerpop
Updated Branches:
refs/heads/master f01d95b0e -> d5eb89435
Add the 3.1.x upgrade doc.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/d5eb8943
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/d5eb8943
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/d5eb8943
Branch: refs/heads/master
Commit: d5eb89435d57dd56dd9f4a3446c79f6fc6926f16
Parents: f01d95b
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Tue Oct 13 12:33:45 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Tue Oct 13 12:33:45 2015 -0400
----------------------------------------------------------------------
.../upgrade-release-3.1.x-incubating.asciidoc | 72 ++++++++++++++++++++
docs/src/upgrade.asciidoc | 2 +
2 files changed, 74 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/d5eb8943/docs/src/upgrade-release-3.1.x-incubating.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/upgrade-release-3.1.x-incubating.asciidoc b/docs/src/upgrade-release-3.1.x-incubating.asciidoc
new file mode 100644
index 0000000..acd22d8
--- /dev/null
+++ b/docs/src/upgrade-release-3.1.x-incubating.asciidoc
@@ -0,0 +1,72 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+////
+
+TinkerPop 3.1.0
+===============
+
+image::https://raw.githubusercontent.com/apache/incubator-tinkerpop/master/docs/static/images/gremlin-gangster.png[width=225]
+
+*A 187 On The Undercover Gremlinz*
+
+TinkerPop 3.1.0
+---------------
+
+*Release Date: NOT OFFICIALLY RELEASED YET*
+
+Additional upgrade information can be found here:
+
+* <<_tinkerpop_3_0_2,TinkerPop 3.0.2>>
+* <<_tinkerpop_3_0_1,TinkerPop 3.0.1>>
+
+Important Changes
+~~~~~~~~~~~~~~~~~
+
+* The Gephi Plugin has improved integration with Gephi, where manually inserting {{store}} steps to visualize a running traversal is no longer required.
+* Entire TinkerGraph instances can be serialized over Gryo.
+
+Please see the link:https://github.com/apache/incubator-tinkerpop/blob/3.1.0-incubating/CHANGELOG.asciidoc#XXXXXXXXXXXXXXXXXXXXXXXXXXXX[changelog] for a complete list of all the modifications that are part of this release.
+
+Upgrading for Users
+~~~~~~~~~~~~~~~~~~~
+
+Transaction.close() Default Behavior
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The default behavior of `Transaction.close()` is to rollback the transaction. This is in contrast to previous versions
+where the default behavior was commit. Using rollback as the default should be thought of as a like a safer approach
+to closing where a user must now explicitly call `commit()` to persist their mutations.
+
+See link:https://issues.apache.org/jira/browse/TINKERPOP3-805[TINKERPOP3-805] for more information.
+
+Upgrading for Providers
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Graph System Providers
+^^^^^^^^^^^^^^^^^^^^^^
+
+Transaction.close() Default Behavior
+++++++++++++++++++++++++++++++++++++
+
+The default behavior for `Transaction.close()` is to rollback the transaction and is enforced by tests, which
+previously asserted the opposite (i.e. commit on close). These tests have been renamed to suite the new semantics:
+
+* `shouldCommitOnCloseByDefault` became `shouldCommitOnCloseWhenConfigured`
+* `shouldRollbackOnCloseWhenConfigured` became `shouldRollbackOnCloseByDefault`
+
+If these tests were referenced in an `OptOut`, then their names should be updated.
+
+See link:https://issues.apache.org/jira/browse/TINKERPOP3-805[TINKERPOP3-805] for more information.
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/d5eb8943/docs/src/upgrade.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/upgrade.asciidoc b/docs/src/upgrade.asciidoc
index 39770e7..86dd6b6 100644
--- a/docs/src/upgrade.asciidoc
+++ b/docs/src/upgrade.asciidoc
@@ -34,4 +34,6 @@ These providers include:
* Graph Driver Provider
* Graph Language Provider
+include::upgrade-release-3.1.x-incubating.asciidoc[]
+
include::upgrade-release-3.0.x-incubating.asciidoc[]
\ No newline at end of file