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 2019/06/06 17:00:43 UTC

[tinkerpop] 01/03: Remove more references to "RemoteGraph" in documentation.

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

spmallette pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git

commit c25b637aac78468a5f3e7e473aed1f3af6da28dc
Author: Stephen Mallette <sp...@genoprime.com>
AuthorDate: Thu Jun 6 12:53:19 2019 -0400

    Remove more references to "RemoteGraph" in documentation.
    
    RemoteGraph is a function of testing within TinkerPop only and is not used directly by users. Users rely on withRemote() from a TraversalSource to construct remote traversals. CTR
---
 docs/src/dev/provider/index.asciidoc             |  2 +-
 docs/src/reference/gremlin-applications.asciidoc | 10 ++++++----
 2 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/docs/src/dev/provider/index.asciidoc b/docs/src/dev/provider/index.asciidoc
index 2fb34b9..d9f63e6 100644
--- a/docs/src/dev/provider/index.asciidoc
+++ b/docs/src/dev/provider/index.asciidoc
@@ -1133,7 +1133,7 @@ request would have sent back thirty traversers.
 
 The full iteration of a `Traversal` is thus left to the client. It must interpret the bulk on the `Traverser` and
 unroll it to represent the actual number of times it exists when iterated. The unrolling is typically handled
-directly within TinkerPop's `RemoteGraph` implementations.
+directly within TinkerPop's remote traversal implementations.
 
 One of the important aspects of the Traversal OpProcessor is that it enables the user to not only get the results of
 the `Traversal` but also the side-effects that it produces. When the `Traversal` is submitted with the "bytecode"
diff --git a/docs/src/reference/gremlin-applications.asciidoc b/docs/src/reference/gremlin-applications.asciidoc
index 62dd553..bafda14 100644
--- a/docs/src/reference/gremlin-applications.asciidoc
+++ b/docs/src/reference/gremlin-applications.asciidoc
@@ -1118,9 +1118,11 @@ If the `Client` instance is supplied externally, as is shown above, then it is n
 "g".  In this case, the `Client` and `Cluster` must both be closed explicitly. Closing "g" and the "cluster" aren'
 t actually both necessary - the close of a `Cluster` will close all `Client` instance spawned by the `Cluster`.
 
-IMPORTANT: `RemoteGraph` uses the `TraversalOpProcessor` in Gremlin Server which requires a cache to enable the
-retrieval of side-effects (if the `Traversal` produces any). That cache can be configured (e.g. controlling eviction
-times and sizing) can be done in the Gremlin Server configuration file as described <<traversalopprocessor, here>>.
+IMPORTANT: Traversals spawned from `withRemote()` use the `TraversalOpProcessor` in Gremlin Server which requires a
+cache to enable the retrieval of side-effects (if the `Traversal` produces any). That cache can be configured (e.g.
+controlling eviction times and sizing) can be done in the Gremlin Server configuration file as described
+<<traversalopprocessor, here>>. If side-effects are never retrieved, it is acceptable to set the `cacheMaxSize` to
+zero to completely disable the cache.
 
 Finally, Gremlin `Bytecode` supports the encoding of bindings which allow GremlinServer to cache traversals that will
 be reused over and over again save that some parameterization may change. Thus, instead of translating, compiling, and
@@ -1315,7 +1317,7 @@ method for processing script evaluation requests.
 [[traversalopprocessor]]
 ===== TraversalOpProcessor
 
-The `TraversalOpProcessor` provides a way to use <<connecting-via-remotegraph,RemoteGraph>>.
+The `TraversalOpProcessor` provides a way to accept traversals configured via <<connecting-via-remotegraph,withRemote()>>.
 
 [width="100%",cols="3,10,^2",options="header"]
 |=========================================================