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 2015/03/26 20:08:49 UTC
incubator-tinkerpop git commit: Add notes about gremlin-shaded and
IDE setup in README.
Repository: incubator-tinkerpop
Updated Branches:
refs/heads/master 9770afa63 -> 1d9437833
Add notes about gremlin-shaded and IDE setup in README.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/1d943783
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/1d943783
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/1d943783
Branch: refs/heads/master
Commit: 1d9437833a89d85a376170254729a44fce01d45e
Parents: 9770afa
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Thu Mar 26 15:08:25 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Thu Mar 26 15:08:25 2015 -0400
----------------------------------------------------------------------
README.asciidoc | 12 ++++++++++++
1 file changed, 12 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/1d943783/README.asciidoc
----------------------------------------------------------------------
diff --git a/README.asciidoc b/README.asciidoc
index 1a0a5a7..459e580 100644
--- a/README.asciidoc
+++ b/README.asciidoc
@@ -44,6 +44,18 @@ Building and Testing
* Performance Tests: `mvn verify -DskipPerformanceTests=false`
* Gatling Load Tests: `mvn test -Pgatling -Dhost={hostname}`
+IDE Setup
+^^^^^^^^^
+
+This section refers specifically to setup within Intellij. TinkerPop has a module called `gremlin-shaded` which contains shaded dependencies for some libraries that are widely used and tend to introduce conflicts. To ensure that Intellij properly interprets this module after importing the Maven `pom.xml` perform the following steps:
+
+. Build `gremlin-shaded` from the command line with `mvn clean install`.
+. Right-click on the `gremlin-shaded` module in the project viewer of Intellij and select "Remove module".
+. In the "Maven Projects" Tool window and click the tool button for "Reimport All Maven projects" (go to `View | Tool Windows | Maven Projects` on the main menu if this panel is not activated).
+. At this point it should be possible to compile and run the tests within Intellij, but in the worst case, use `File | Invalidate Caches/Restart` to ensure that indices properly rebuild.
+
+Note that it maybe be necessary to re-execute these steps if the `gremlin-shaded` `pom.xml` is ever updated.
+
Get Started
~~~~~~~~~~~