[tinkerpop] branch TINKERPOP-2161 updated: Add subsection to upgrade docs

[jo...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jorgebg pushed a commit to branch TINKERPOP-2161
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git


The following commit(s) were added to refs/heads/TINKERPOP-2161 by this push:
     new 3e18418  Add subsection to upgrade docs
3e18418 is described below

commit 3e18418142aa089e9a70af734c47b78978725232
Author: Jorge Bay Gondra <jo...@gmail.com>
AuthorDate: Mon Feb 25 09:52:21 2019 +0100

    Add subsection to upgrade docs
---
 CHANGELOG.asciidoc                      |  3 +--
 docs/src/upgrade/release-3.4.x.asciidoc | 10 ++++++++++
 2 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc
index f60c48e..ea8205f 100644
--- a/CHANGELOG.asciidoc
+++ b/CHANGELOG.asciidoc
@@ -35,8 +35,7 @@ This release also includes changes from <<release-3-3-6, 3.3.6>>.
 * Added easier to understand exceptions for connection problems in the Gremlin.Net driver.
 * Support configuring the type registry builder for GraphBinary.
 * Release working buffers in case of failure for GraphBinary.
-* GraphBinary: Use the same `ByteBuf` instance to write during serialization. Changed signature of write methods in type
-serializers.
+* GraphBinary: Use the same `ByteBuf` instance to write during serialization. Changed signature of write methods in type serializers.
 * Remove unused parameter in GraphBinary's `ResponseMessageSerializer`.
 
 
diff --git a/docs/src/upgrade/release-3.4.x.asciidoc b/docs/src/upgrade/release-3.4.x.asciidoc
index 5b052f1..ac9f8dc 100644
--- a/docs/src/upgrade/release-3.4.x.asciidoc
+++ b/docs/src/upgrade/release-3.4.x.asciidoc
@@ -27,6 +27,16 @@ image::https://raw.githubusercontent.com/apache/tinkerpop/master/docs/static/ima
 
 Please see the link:https://github.com/apache/tinkerpop/blob/3.4.1/CHANGELOG.asciidoc#release-3-4-1[changelog] for a complete list of all the modifications that are part of this release.
 
+=== Upgrading for Providers
+
+==== Graph Database Providers
+
+===== GraphBinary Serializer Changes
+
+In GraphBinary serialization, Java `write()` and `writeValue()` from `TypeSerializer<T>` interface now take a Netty's
+`ByteBuf` instance instead of an `ByteBufAllocator`, that way the same buffer instance gets reused during the write
+of a message. Additionally, we took the opportunity to remove the unused parameter from `ResponseMessageSerializer`.
+
 == TinkerPop 3.4.0
 
 *Release Date: January 2, 2019*