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 2017/05/09 12:35:39 UTC

[05/20] tinkerpop git commit: TINKERPOP-786 Updated docs for intellij setup

TINKERPOP-786 Updated docs for intellij setup

Now that we have a annotation processor in gremlin-core there are some additional setup instructions required for Intellij to ensure tests can run through the debugger.


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

Branch: refs/heads/TINKERPOP-786
Commit: d2b7f9a27d20ee03dd0b8180444bcf9f24064877
Parents: 01e47ec
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Thu May 4 10:27:27 2017 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Tue May 9 08:12:27 2017 -0400

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


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/d2b7f9a2/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 4a7a3f0..98a89f7 100644
--- a/docs/src/dev/developer/development-environment.asciidoc
+++ b/docs/src/dev/developer/development-environment.asciidoc
@@ -223,3 +223,13 @@ This will ensure that tests will properly execute within the IDE.
 
 If Intellij complains about "duplicate sources" for the Groovy files when attempting to compile/run tests, then
 install the link:http://plugins.jetbrains.com/plugin/7442?pr=idea[GMavenPlus Intellij plugin].
+
+The `gremlin-core` module uses a Java annotation processor to help support DSLs. To support this capability be sure
+that:
+
+. `File | Settings | Compiler | Annotation Processors` has the checkbox with the "Enable annotation processing" checked.
+Intellij should be able to detect the processor automatically on build.
+. The `gremlin-core/target` directory should not be hidden and `target/classes`, `target/gneerated-sources` and
+`target/generated-test-sources should be marked as "Generated Sources Root". If they are not setup that way by
+Intellij by default then simply right-click on them use the "Mark Directory with" option to make the appropriate
+selections.