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/12/07 20:02:35 UTC

[12/50] tinkerpop git commit: added doc

added doc


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

Branch: refs/heads/TINKERPOP-1490
Commit: 1e80537bc0d25a847f3efda36ef23c086ac9b59f
Parents: 5c43053
Author: Robert Dale <ro...@gmail.com>
Authored: Sat Nov 19 04:10:04 2016 -0500
Committer: Robert Dale <ro...@gmail.com>
Committed: Sat Nov 19 04:10:04 2016 -0500

----------------------------------------------------------------------
 .../developer/development-environment.asciidoc    | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/1e80537b/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 2369133..f7ef0b7 100644
--- a/docs/src/dev/developer/development-environment.asciidoc
+++ b/docs/src/dev/developer/development-environment.asciidoc
@@ -56,7 +56,7 @@ Docker Integration
 ------------------
 
 TinkerPop provides a shell script, that can start several build tasks within a Docker container. The
-required Docker images will be built automatically if they don't exist yet. Thus the first invokation
+required Docker images will be built automatically if they don't exist yet. Thus the first invocation
 of the Docker script is expected to take some time.
 
 The script can be found under `PROJECT_HOME/docker/build.sh`. The following tasks are currently
@@ -70,11 +70,27 @@ supported:
 A list of command line options is provided by `docker/build.sh --help`. The container will install,
 configure and start all required dependencies, such as Hadoop.
 
+Options can be passed to Docker by setting the `TINKERPOP_DOCKER_OPTS` environment variable. A speed boost can
+be gained at the expense of memory by using tmpfs and the special directory `/usr/src/tinkermem`.
+
+[source,bash]
+.Build in-memory
+----
+TINKERPOP_DOCKER_OPTS="--tmpfs /usr/src/tinkermem:exec,mode=0755,rw,noatime,size=2000m"
+----
+
+[source,bash]
+.Disable IPv6 for Hadoop
+----
+TINKERPOP_DOCKER_OPTS="--sysctl net.ipv6.conf.all.disable_ipv6=1 --sysctl net.ipv6.conf.default.disable_ipv6=1"
+----
+
 If the container is used to generate the user docs, it will start a web server and show the URL that
 is used to host the HTML docs.
 
 After finishing all tasks, the script will immediately destroy the container.
 
+
 IDE Setup with Intellij
 -----------------------