incubator-tinkerpop git commit: Add some docs for vendors around proper IO testing.

[sp...@apache.org]

Repository: incubator-tinkerpop
Updated Branches:
  refs/heads/master d1f5f8603 -> 883a3de2b


Add some docs for vendors around proper IO testing.


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

Branch: refs/heads/master
Commit: 883a3de2b8adef99e1711781b00bc8df54ebed35
Parents: d1f5f86
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Fri May 15 08:17:37 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Fri May 15 08:17:37 2015 -0400

----------------------------------------------------------------------
 docs/src/implementations.asciidoc | 4 ++++
 1 file changed, 4 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/883a3de2/docs/src/implementations.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/implementations.asciidoc b/docs/src/implementations.asciidoc
index bd77901..c78e807 100644
--- a/docs/src/implementations.asciidoc
+++ b/docs/src/implementations.asciidoc
@@ -266,6 +266,8 @@ public <I extends Io> I io(final Io.Builder<I> builder) {
 
 In this way, `Graph` implementations can pre-configure custom serializers for IO interactions and users will not need to know about those details. Following this pattern will ensure proper execution of the test suite as well as simplified usage for end-users.
 
+IMPORTANT: Proper implementation of IO is critical to successful `Graph` operations in Gremlin Server.  The Test Suite does have "serialization" tests that provide some assurance that an implementation is working properly, but those tests cannot make assertions against any specifics of a custom serializer.  It is the responsibility of the implementer to test the specifics of their custom serializers.
+
 [[validating-with-gremlin-test]]
 Validating with Gremlin-Test
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -375,6 +377,8 @@ These annotations help provide users a level of transparency into test suite com
 
 IMPORTANT: Before using `OptOut` be sure that the reason for using it is sound and it is more of a last resort.  It is possible that a test from the suite is doesn't properly represent the expectations of a feature, is too broad or narrow for the semantics it is trying to enforce or simply contains a bug.  Please consider raising issues in the developer mailing list with such concerns before assuming `OptOut` is the only answer.
 
+IMPORTANT: There are no tests that specifically validate complete compliance with Gremlin Server.  Generally speaking, a `Graph` that passes the full Test Suite, should be compliant with Gremlin Server.  The one area where problems can occur is in serialization.  Always ensure that IO is properly implemented, that custom serializers are tested fully and ultimately integration test the `Graph` with an actual Gremlin Server instance.
+
 Accessibility via GremlinPlugin
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~