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 2016/03/09 21:51:48 UTC
[3/3] incubator-tinkerpop git commit: Swithed all CAUTION: to
WARNING: to be consistent.
Swithed all CAUTION: to WARNING: to be consistent.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/95bb1641
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/95bb1641
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/95bb1641
Branch: refs/heads/TINKERPOP-1096
Commit: 95bb1641b46ff31b9f3f3670185c26056d77cc3a
Parents: 2881ec4
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Wed Mar 9 15:51:17 2016 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Wed Mar 9 15:51:17 2016 -0500
----------------------------------------------------------------------
docs/src/dev/provider/index.asciidoc | 2 +-
docs/src/reference/gremlin-applications.asciidoc | 6 +++---
docs/src/reference/implementations-hadoop.asciidoc | 4 ++--
docs/src/reference/implementations-neo4j.asciidoc | 2 +-
docs/src/reference/intro.asciidoc | 8 ++++----
docs/src/reference/the-graph.asciidoc | 6 +++---
docs/src/reference/the-traversal.asciidoc | 8 ++++----
7 files changed, 18 insertions(+), 18 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/95bb1641/docs/src/dev/provider/index.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/dev/provider/index.asciidoc b/docs/src/dev/provider/index.asciidoc
index 4624bb1..3299618 100644
--- a/docs/src/dev/provider/index.asciidoc
+++ b/docs/src/dev/provider/index.asciidoc
@@ -499,7 +499,7 @@ a `Graph` that passes the full Test Suite, should be compliant with Gremlin Serv
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.
-CAUTION: Configuring tests to run in parallel might result in errors that are difficult to debug as there is some
+WARNING: Configuring tests to run in parallel might result in errors that are difficult to debug as there is some
shared state in test execution around graph configuration. It is therefore recommended that parallelism be turned
off for the test suite (the Maven SureFire Plugin is configured this way by default). It may also be important to
include this setting, `<reuseForks>false</reuseForks>`, in the SureFire configuration if tests are failing in an
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/95bb1641/docs/src/reference/gremlin-applications.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/reference/gremlin-applications.asciidoc b/docs/src/reference/gremlin-applications.asciidoc
index a1436f1..8d4936a 100644
--- a/docs/src/reference/gremlin-applications.asciidoc
+++ b/docs/src/reference/gremlin-applications.asciidoc
@@ -70,7 +70,7 @@ Plugins. Consider adding the "local" reference first in the set of `<ibilio>` r
"apache-snapshots" will likely resolve dependencies from that repository before looking locally. If it does that,
then it's possible that the artifact from the newer local build will not be used.
-CAUTION: If building TinkerPop from source, be sure to clear TinkerPop-related jars from the `~/.groovy/grapes`
+WARNING: If building TinkerPop from source, be sure to clear TinkerPop-related jars from the `~/.groovy/grapes`
directory as they can become stale on some systems and not re-import properly from the local `.m2` after fresh rebuilds.
[[gremlin-console]]
@@ -214,7 +214,7 @@ the Console classpath. Plugins need to be "active" for their features to be ava
<5> Again, to use the "tinkerpop.neo4j" plugin, it must be made "active" with `:plugin use`.
<6> Now when the plugin list is displayed, the "tinkerpop.neo4j" plugin is displayed as "active".
-CAUTION: Plugins must be compatible with the version of the Gremlin Console (or Gremlin Server) being used. Attempts
+WARNING: Plugins must be compatible with the version of the Gremlin Console (or Gremlin Server) being used. Attempts
to use incompatible versions cannot be guaranteed to work. Moreover, be prepared for dependency conflicts in
third-party plugins, that may only be resolved via manual jar removal from the `ext/{plugin}` directory.
@@ -761,7 +761,7 @@ curl -X POST -d "{\"gremlin\":\"100-x\", \"language\":\"gremlin-groovy\", \"bind
By default this value is set to `gremlin-groovy`. If using a `GET` operation, this value can be set as a query
string argument with by setting the `language` key.
-CAUTION: Consider the size of the result of a submitted script being returned from the REST endpoint. A script
+WARNING: Consider the size of the result of a submitted script being returned from the REST endpoint. A script
that iterates thousands of results will serialize each of those in memory into a single JSON result set. It is
quite possible that such a script will generate `OutOfMemoryError` exceptions on the server. Consider the default
WebSockets configuration, which supports streaming, if that type of use case is required.
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/95bb1641/docs/src/reference/implementations-hadoop.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/reference/implementations-hadoop.asciidoc b/docs/src/reference/implementations-hadoop.asciidoc
index 376f377..59c7412 100644
--- a/docs/src/reference/implementations-hadoop.asciidoc
+++ b/docs/src/reference/implementations-hadoop.asciidoc
@@ -150,7 +150,7 @@ However, realize that the underlying HDFS files are not random access and thus,
is required. OLTP operations are useful for peeking into the graph prior to executing a long running OLAP job -- e.g.
`g.V().valueMap().limit(10)`.
-CAUTION: OLTP operations on `HadoopGraph` are not efficient. They require linear scans to execute and are unreasonable
+WARNING: OLTP operations on `HadoopGraph` are not efficient. They require linear scans to execute and are unreasonable
for large graphs. In such large graph situations, make use of <<traversalvertexprogram,TraversalVertexProgram>>
which is the OLAP Gremlin machine.
@@ -229,7 +229,7 @@ etc.). Unfortunately, typically these dependencies are not to the same versions
it is best to *not* have both Spark and Giraph plugins loaded in the same console session nor in the same Java
project (though intelligent `<exclusion>`-usage can help alleviate conflicts in a Java project).
-CAUTION: It is important to note that when doing an OLAP traversal, any resulting vertices, edges, or properties will be
+WARNING: It is important to note that when doing an OLAP traversal, any resulting vertices, edges, or properties will be
attached to the source graph. For Hadoop-based graphs, this may lead to linear search times on massive graphs. Thus,
if vertex, edge, or property objects are to be returns (as a final result), it is best to `.id()` to get the id
of the object and not the actual attached object.
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/95bb1641/docs/src/reference/implementations-neo4j.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/reference/implementations-neo4j.asciidoc b/docs/src/reference/implementations-neo4j.asciidoc
index 9accd25..2e47180 100644
--- a/docs/src/reference/implementations-neo4j.asciidoc
+++ b/docs/src/reference/implementations-neo4j.asciidoc
@@ -35,7 +35,7 @@ Neo4j-Gremlin
link:http://neotechnology.com[Neo Technology] are the developers of the OLTP-based link:http://neo4j.org[Neo4j graph database].
-CAUTION: Unless under a commercial agreement with Neo Technology, Neo4j is licensed
+WARNING: Unless under a commercial agreement with Neo Technology, Neo4j is licensed
link:http://en.wikipedia.org/wiki/Affero_General_Public_License[AGPL]. The `neo4j-gremlin` module is licensed Apache2
because it only references the Apache2-licensed Neo4j API (not its implementation). Note that neither the
<<gremlin-console,Gremlin Console>> nor <<gremlin-server,Gremlin Server>> distribute with the Neo4j implementation
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/95bb1641/docs/src/reference/intro.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/reference/intro.asciidoc b/docs/src/reference/intro.asciidoc
index 8fb82e3..a8c6a1a 100644
--- a/docs/src/reference/intro.asciidoc
+++ b/docs/src/reference/intro.asciidoc
@@ -119,7 +119,7 @@ In the above code all the vertices are created first and then their respective e
`Graph.addVertex(Object...)` or `Vertex.addEdge(String,Vertex,Object...)`, the respective element is created along
with the provided key/value pair properties appended to it.
-CAUTION: Many graph systems do not allow the user to specify an element ID and in such cases, an exception is thrown.
+WARNING: Many graph systems do not allow the user to specify an element ID and in such cases, an exception is thrown.
NOTE: In TinkerPop3, vertices are allowed a single immutable string label (similar to an edge label). This
functionality did not exist in TinkerPop2. Element ids are still immutable in TinkerPop3 as they were in TinkerPop2.
@@ -133,7 +133,7 @@ in favor of a syntax that is more aligned with the syntax of Gremlin-Groovy in T
and Gremlin-Groovy are nearly identical due to the inclusion of Java 8 lambdas, a big effort was made to ensure that
both languages are as similar as possible.
-CAUTION: In the code examples presented throughout this documentation, either Gremlin-Java8 or Gremlin-Groovy is used.
+WARNING: In the code examples presented throughout this documentation, either Gremlin-Java8 or Gremlin-Groovy is used.
It is possible to determine which derivative of Gremlin is being used by mousing over the code block. The word "JAVA"
or "GROOVY" will appear in the top right corner of the code block.
@@ -322,7 +322,7 @@ the current object being traversed, etc. Traverser metadata may be accessed by a
g.V(marko).out('knows').values('name').path()
----
-CAUTION: Path calculation is costly in terms of space as an array of previously seen objects is stored in each path
+WARNING: Path calculation is costly in terms of space as an array of previously seen objects is stored in each path
of the respective traverser. Thus, a traversal strategy analyzes the traversal to determine if path metadata is
required. If not, then path calculations are turned off.
@@ -334,7 +334,7 @@ has gone through a particular section of the traversal expression (i.e. a loop).
g.V(marko).repeat(out()).times(2).values('name')
----
-CAUTION: A Traversal's result are never ordered unless explicitly by means of <<order-step,`order()`>>-step. Thus,
+WARNING: A Traversal's result are never ordered unless explicitly by means of <<order-step,`order()`>>-step. Thus,
never rely on the iteration order between TinkerPop3 releases and even within a release (as traversal optimizations
may alter the flow).
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/95bb1641/docs/src/reference/the-graph.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/reference/the-graph.asciidoc b/docs/src/reference/the-graph.asciidoc
index bc914b5..e0e59f9 100644
--- a/docs/src/reference/the-graph.asciidoc
+++ b/docs/src/reference/the-graph.asciidoc
@@ -408,10 +408,10 @@ applications outside of TinkerPop, GraphML may be the best choice to do that. Co
As GraphML is a specification for the serialization of an entire graph and not the individual elements of a graph,
methods that support input and output of single vertices, edges, etc. are not supported.
-CAUTION: GraphML is a "lossy" format in that it only supports primitive values for properties and does not have
+WARNING: GraphML is a "lossy" format in that it only supports primitive values for properties and does not have
support for `Graph` variables. It will use `toString` to serialize property values outside of those primitives.
-CAUTION: GraphML as a specification allows for `<edge>` and `<node>` elements to appear in any order. Most software
+WARNING: GraphML as a specification allows for `<edge>` and `<node>` elements to appear in any order. Most software
that writes GraphML (including as TinkerPop's `GraphMLWriter`) write `<node>` elements before `<edge>` elements. However it
is important to note that `GraphMLReader` will read this data in order and order can matter. This is because TinkerPop
does not allow the vertex label to be changed after the vertex has been created. Therefore, if an `<edge>` element
@@ -665,7 +665,7 @@ with graph data inside of the TinkerPop stack. A list of common use cases is pre
* Serialization of individual graph elements to be sent over the network to another JVM.
* Backups of in-memory graphs or subgraphs.
-CAUTION: When migrating between Gremlin Structure implementations, Kryo may not lose data, but it is important to
+WARNING: When migrating between Gremlin Structure implementations, Kryo may not lose data, but it is important to
consider the features of each `Graph` and whether or not the data types supported in one will be supported in the
other. Failure to do so, may result in errors.
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/95bb1641/docs/src/reference/the-traversal.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/reference/the-traversal.asciidoc b/docs/src/reference/the-traversal.asciidoc
index 3f6b4e9..139574f 100644
--- a/docs/src/reference/the-traversal.asciidoc
+++ b/docs/src/reference/the-traversal.asciidoc
@@ -59,7 +59,7 @@ the verbose syntax `__.in()` and `__.as()` to avoid collisions.
Lambda Steps
~~~~~~~~~~~~
-CAUTION: Lambda steps are presented for educational purposes as they represent the foundational constructs of the
+WARNING: Lambda steps are presented for educational purposes as they represent the foundational constructs of the
Gremlin language. In practice, lambda steps should be avoided and traversal verification strategies exist to disallow t
heir use unless explicitly "turned off." For more information on the problems with lambdas, please read
<<a-note-on-lambdas,A Note on Lambdas>>.
@@ -1611,7 +1611,7 @@ g.V().hasLabel('song').out('sungBy').groupCount().by('name').select(values).unfo
<2> Get an anonymized set of song repertoire sizes.
<3> What are the 5 most common song repertoire sizes?
-CAUTION: Note that `by()`-modulation is not supported with `select(keys)` and `select(values)`.
+WARNING: Note that `by()`-modulation is not supported with `select(keys)` and `select(values)`.
[[using-where-with-select]]
Using Where with Select
@@ -2245,7 +2245,7 @@ t.iterate(); null
t.toString()
----
-CAUTION: The reason that `OptimizationStrategy` and `ProviderOptimizationStrategy` are two different categories is
+WARNING: The reason that `OptimizationStrategy` and `ProviderOptimizationStrategy` are two different categories is
that optimization strategies should only rewrite the traversal using TinkerPop3 steps. This ensures that the
optimizations executed at the end of the optimization strategy round are TinkerPop3 compliant. From there, provider
optimizations can analyze the traversal and rewrite the traversal as desired using graph system specific steps (e.g.
@@ -2324,7 +2324,7 @@ where the removed edge count is accounted for after the event is raised. The st
`TransactionalEventQueue` that captures the changes within a transaction and does not allow them to fire until the
transaction is committed.
-CAUTION: `EventStrategy` is not meant for usage in tracking global mutations across separate processes. In other
+WARNING: `EventStrategy` is not meant for usage in tracking global mutations across separate processes. In other
words, a mutation in one JVM process is not raised as an event in a different JVM process. In addition, events are
not raised when mutations occur outside of the `Traversal` context.