[3/4] incubator-tinkerpop git commit: added notes for --noClean in developer docs

[dk...@apache.org]

added notes for --noClean in developer docs


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

Branch: refs/heads/master
Commit: f83a59437aedec86e079be90be9c64259a0fb9ef
Parents: 60866a2
Author: Daniel Kuppitz <da...@hotmail.com>
Authored: Wed Jan 6 11:40:28 2016 +0100
Committer: Daniel Kuppitz <da...@hotmail.com>
Committed: Wed Jan 6 11:40:28 2016 +0100

----------------------------------------------------------------------
 docs/src/dev/developer/contributing.asciidoc | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/f83a5943/docs/src/dev/developer/contributing.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/dev/developer/contributing.asciidoc b/docs/src/dev/developer/contributing.asciidoc
index 2cf229d..53b4e12 100644
--- a/docs/src/dev/developer/contributing.asciidoc
+++ b/docs/src/dev/developer/contributing.asciidoc
@@ -44,8 +44,10 @@ Before issuing your pull request, please be sure of the following:
 . If the change requires modification to the documentation, which can be found in `docs/src`, please be sure to try to
 generate the docs.  If the changes are minimal and do not include code examples, it might be sufficient to test
 generate the docs to validate formatting by just doing `bin/process-docs.sh --dryRun`.  If there are code examples,
-please be sure to have Zookeeper and Hadoop running when doing a `bin/process-docs.sh`.  The documentation is
-generated to `/target/docs/htmlsingle`.
+please be sure to have Zookeeper and Hadoop running when doing a `bin/process-docs.sh`.  If no code changes were made,
+one can also use the `--noClean` option. This will prevent the processor from cleaning up the local Grapes directory and
+the Hadoop Gremlin Libs directory in HDFS, resulting in a slightly faster execution time. The documentation is generated
+to `/target/docs/htmlsingle`.
 . If necessary, run the integration tests.  For example, if the changes affect serialization or Gremlin Server/Driver
 operations then running the integration tests assures in addition to unit tests will definitely be necessary. After
 a successful `mvn clean install`, do `mvn verify -DskipIntegrationTests=false -pl gremlin-server`.
@@ -441,4 +443,4 @@ for debugging purposes within tests can be altered by editing the `log4j-test.pr
 resources.  That file gets copied to the `target/test-classes` on build and surefire and failsafe plugins in maven
 are then configured to point at that area of the file system for those configuration files. The properties files
 can be edited to fine tune control of the log output, but generally speaking the current configuration is likely
-best for everyone's general purposes, so if changes are made please revert them prior to commit.
\ No newline at end of file
+best for everyone's general purposes, so if changes are made please revert them prior to commit.