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/08/26 21:51:44 UTC

tinkerpop git commit: Add docs for building gremlin-python

Repository: tinkerpop
Updated Branches:
  refs/heads/TINKERPOP-1278 6463cffa2 -> dd202e2fc


Add docs for building gremlin-python


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

Branch: refs/heads/TINKERPOP-1278
Commit: dd202e2fcdf70c5b0f8730fbed5864c445ed582e
Parents: 6463cff
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Fri Aug 26 17:51:18 2016 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Fri Aug 26 17:51:18 2016 -0400

----------------------------------------------------------------------
 docs/src/dev/developer/development-environment.asciidoc | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/dd202e2f/docs/src/dev/developer/development-environment.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/dev/developer/development-environment.asciidoc b/docs/src/dev/developer/development-environment.asciidoc
index da6dc16..0d11d85 100644
--- a/docs/src/dev/developer/development-environment.asciidoc
+++ b/docs/src/dev/developer/development-environment.asciidoc
@@ -21,7 +21,10 @@ Development Environment
 Building and Testing
 --------------------
 
-TinkerPop requires `Java 1.8.0_40+` for proper building and proper operations.
+TinkerPop requires `Java 1.8.0_40+` for standard building and operations. In addition, it optionally requires Python
+2.x to work with the `gremlin-python` module. If Python is not installed, TinkerPop will still build with Maven, but
+native Python tests and Java tests that require Python code will be skipped. It will also not be possible to do
+deployments.
 
 * Build Project: `mvn clean install`
 ** Specify specific tests in a TinkerPop Suite to run with the `GREMLIN_TESTS` environment variable, along with the
@@ -34,6 +37,7 @@ mvn -Dmaven.javadoc.skip=true --projects tinkergraph-gremlin test
 ** Clean the `.groovy/grapes/org.apache.tinkerpop` directory on build: `mvn clean install -DcleanGrapes`
 ** Turn off "heavy" logging in the "process" tests: `mvn clean install -DargLine="-DmuteTestLogs=true"`
 ** The test suite for `neo4j-gremlin` is disabled by default - to turn it on: `mvn clean install -DincludeNeo4j`
+** Build the `gremlin-python` module with native Python tests (which require that Python be installed on the system): `mvn clean install -DglvPython`
 * Regenerate test data (only necessary given changes to IO classes): `mvn clean install -Dio` from `tinkergraph-gremlin` directory
 ** If there are changes to the Gryo format, it may be necessary to generate the Grateful Dead dataset from GraphSON (see `IoDataGenerationTest.shouldWriteGratefulDead`)
 * Check license headers are present: `mvn apache-rat:check`